Class EditorServerSettings

All Implemented Interfaces:
IPropDesigner, ITooltipPropList, IServerSettings, EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable, org.eclipse.core.runtime.IAdaptable

public class EditorServerSettings extends ServerSettings implements IPropDesigner, ITooltipPropList
Editor version of the container that holds the required settings for the server to operate and initialize itself with.
  • Constructor Details

    • EditorServerSettings

      public EditorServerSettings()
      Creates the property container without a name. The name must be set in all cases using the setPropertyAtom call.
    • EditorServerSettings

      public EditorServerSettings(Atom propertyAtom)
      Creates the property container with the specified name. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - the name of the component, unique within it's parent.
  • Method Details

    • assignConfigFile

      public void assignConfigFile(File file)
      Assigns the config file.
      Parameters:
      file - The config file.
    • getConfigFile

      public File getConfigFile()
      Gets the config file.
      Returns:
      The config file, null if not loaded yet.
    • createPolicyProps

      protected EditorPolicyProps createPolicyProps(Atom atom)
      Creates a policy property with the specified atom name.
      Overrides:
      createPolicyProps in class ServerSettings
      Parameters:
      atom - The atom name.
      Returns:
      The policy property.
    • getFileName

      public String getFileName()
      Gets the file name.
    • setFileName

      public void setFileName(String fileName)
      Assigns the file name.
    • getDesigner

      public ServerConfigDesignerProp getDesigner()
      Gets the Designer Extension for Properties.
      Specified by:
      getDesigner in interface IPropDesigner
      Returns:
      The instance of the Designer Extension.
    • getPossibleChildren

      public Class<?>[] getPossibleChildren()
      Gets the acceptable children property classes that can be used in conjunction with e.g. a Paste operation.
      Specified by:
      getPossibleChildren in interface IPropCnr
      Overrides:
      getPossibleChildren in class PropCnr
      Returns:
      An array containing the classes of possible children, or null for no support.
    • clone

      public EditorServerSettings clone()
      Clone must be overridden.
      Overrides:
      clone in class ServerSettings
    • onServerSettingsChanged

      public void onServerSettingsChanged()
      Called when loaded to update the ServerProps instance.
      Overrides:
      onServerSettingsChanged in class ServerSettings
    • getServerConfigEnvironment

      public EditorServerConfigEnvProps getServerConfigEnvironment(String name)
      Gets the configuration environment of a name.
      Overrides:
      getServerConfigEnvironment in class ServerSettings
      Parameters:
      name - The name (e.g. "test", "development" or "production"), or null for default configuration environment name.
      Returns:
      The configuration setup, or null if not found.
    • getServerConfigEnvironments

      public EditorServerConfigEnvProps[] getServerConfigEnvironments()
      Gets the array of configuration environments present.
      Overrides:
      getServerConfigEnvironments in class ServerSettings
    • getTooltipPropertyList

      public List<TooltipItem> getTooltipPropertyList()
      Gets the list of property names that should be displayed.
      Specified by:
      getTooltipPropertyList in interface ITooltipPropList
      Returns:
      The list, or null for no tooltip.