Class InfrastructureFileDescriptor

java.lang.Object
net.sourceforge.jnlp.config.InfrastructureFileDescriptor
Direct Known Subclasses:
PathsAndFiles.CacheFileDescriptor, PathsAndFiles.ConfigFileDescriptor, PathsAndFiles.DataFileDescriptor, PathsAndFiles.HomeFileDescriptor, PathsAndFiles.RuntimeFileDescriptor, PathsAndFiles.SystemConfigFileDescriptor, PathsAndFiles.SystemJavaFileDescriptor, PathsAndFiles.TmpUsrFileDescriptor
public class InfrastructureFileDescriptor extends Object

  • Field Details

    • fileName

      private final String fileName

    • pathStub

      private final String pathStub

    • systemPathStub

      private final String systemPathStub

    • descriptionKey

      private final String descriptionKey

    • target

      final Target[] target

  • Constructor Details

    • InfrastructureFileDescriptor

      protected InfrastructureFileDescriptor()

    • InfrastructureFileDescriptor

      InfrastructureFileDescriptor(String fileName, String pathStub, String systemPathStub, String descriptionKey, Target... target)

  • Method Details

    • getPropertiesKey

      protected String getPropertiesKey()
      setup-able files have to override this if they don't, they are read only, and set value will fail if it is desired to write value of property, then override and use known key.
      Returns:
      null by default. Should return key to configuration if overridden.

    • getFile

      public File getFile()

    • getUrl

      public URL getUrl() throws MalformedURLException
      Throws:
      MalformedURLException

    • setValue

      public void setValue(String value)

    • getFullPath

      public String getFullPath()

    • setValue

      public void setValue(String value, DeploymentConfiguration config)
      overload version for control panel, which is saving to internal copy.
      Parameters:
      value - new path of file
      config - config where t write this value (note, usually JNLPRuntime.getConfiguration() so you don't need it, but our config gui tool is using two sets to allow undo.

    • getFullPath

      public String getFullPath(DeploymentConfiguration config)
      overload version for control panel, which is saving to internal copy.
      Parameters:
      config - config from where to read this value (note, usually JNLPRuntime.getConfiguration() so you don't need it, but our config gui tool is using two sets to allow undo.
      Returns:
      configured property or default

    • getDefaultFullPath

      public String getDefaultFullPath()

    • getSystemPathStubAcronym

      protected String getSystemPathStubAcronym()

    • getFileName

      protected String getFileName()

    • getDescriptionKey

      protected String getDescriptionKey()

    • getStub

      private String getStub()
      This remaining part of file declaration, when acronym is removed. See getDirViaAcronym.
      Returns:

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getDirViaAcronym

      public String getDirViaAcronym()
      For documentation purposes, the descriptor may be created as VARIABLE/custom/path.

      This is whole part, which is considered as setup-able.

      Returns:
      directory acronym for nice docs

    • clean

      protected String clean(String s)
      Remove garbage from paths.

      Currently this methods unify all multiple occurrences of separators to single one. Eg /path/to//file will become /path/to/file.

      Those artifacts maybe spread during various s=path+separator+subdir+separator file=s+separator+filename

      Parameters:
      s - string to be cleaned
      Returns:
      cleaned string

    • getDescription

      public String getDescription()
      Returns:
      the translated description