Class ApplicationDesc

java.lang.Object
net.adoptopenjdk.icedteaweb.jnlp.element.application.ApplicationDesc
All Implemented Interfaces:
EntryPoint
public class ApplicationDesc extends Object implements EntryPoint
The application-desc element contains all information needed to launch an application, given the resources described by the resources element. A JNLP file is an application descriptor if the application-desc element is specified.

  • Field Details

    • APPLICATION_DESC_ELEMENT

      public static final String APPLICATION_DESC_ELEMENT
      See Also:

    • JAVAFX_DESC_ELEMENT

      public static final String JAVAFX_DESC_ELEMENT
      See Also:

    • ARGUMENT_ELEMENT

      public static final String ARGUMENT_ELEMENT
      See Also:

    • PROGRESS_CLASS_ATTRIBUTE

      public static final String PROGRESS_CLASS_ATTRIBUTE
      See Also:

    • type

      private final ApplicationType type
      The type of application supported by the JNLP Client. The optional attribute indicates the type of application contained in the resources and identified by the main-class attribute. The default value is ApplicationType.JAVA.

      If given the type attribute value is not supported by the JNLP Client, the launch should be aborted. If a JNLP Client supports other types of applications (such as "JavaFX", or "JRuby"), The meaning and/or use of the other application-desc attributes (main-class and progress-class) and sub-elements (argument and param) may vary as is appropriate for that type of application.

    • mainClass

      private final String mainClass
      For Java applications this method returns the name of the class containing the public static void main(String[]) method. The name and/or meaning may vary as is appropriate for other types of applications.

    • progressClass

      private final String progressClass
      The name of a class containing an implementation of the DownloadServiceListener interface of applications. May be used to indicate download progress.

    • arguments

      private final List<String> arguments
      Contains an ordered list of arguments for the application.

  • Constructor Details

    • ApplicationDesc

      public ApplicationDesc(String mainClass, String[] arguments)
      Creates an application descriptor element.
      Parameters:
      mainClass - the fully qualified name of the class containing the main method of the application
      arguments - the arguments

    • ApplicationDesc

      public ApplicationDesc(ApplicationType type, String mainClass, String[] arguments)
      Creates an application descriptor element.
      Parameters:
      type - the type of application supported by the JNLP Client
      mainClass - the fully qualified name of the class containing the main method of the application
      arguments - the arguments

    • ApplicationDesc

      public ApplicationDesc(ApplicationType type, String mainClass, String progressClass, String[] arguments)
      Creates an application descriptor element.
      Parameters:
      type - the type of application supported by the JNLP Client
      mainClass - the fully qualified name of the class containing the main method of the application
      progressClass - the fully qualified name of the class containing an implementation of the DownloadServiceListener interface
      arguments - the arguments

  • Method Details

    • getType

      public ApplicationType getType()
      Returns:
      the type of application supported by the JNLP Client

    • getMainClass

      public String getMainClass()
      For Java applications this method returns the name of the class containing the public static void main(String[]) method. The name and/or meaning may vary as is appropriate for other types of applications.

      This attribute can be omitted if the main class can be found from the Main-Class manifest entry in the main JAR file.

      Specified by:
      getMainClass in interface EntryPoint
      Returns:
      the fully qualified name of the class containing the main method of the application

    • getProgressClass

      public String getProgressClass()
      The name of a class containing an implementation of the DownloadServiceListener interface of applications.
      Returns:
      the fully qualified name of the class containing an implementation of the DownloadServiceListener interface

    • getArguments

      public String[] getArguments()
      Contains an ordered list of arguments for the application.
      Returns:
      the arguments

    • addArgument

      public void addArgument(String argument)
      Add an argument to the end of the ordered list of arguments.
      Parameters:
      argument - argument of command