com.ibm.etools.systems.pushtoclient.core.extensions

Interface IConfigurationElement

  • All Superinterfaces:
    java.lang.Comparable<IConfigurationElement>
    All Known Implementing Classes:
    ConfigurationElement


    public interface IConfigurationElement
    extends java.lang.Comparable<IConfigurationElement>
    Represents a configuration or a category of configuration for import or export. Most providers will use the ConfigurationElement class rather than directly implement this interface.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void add(IConfigurationElement child)
      Add a child configuration element to this configuration element.
      java.lang.String getBuffer()
      Returns the buffer (if there is one) associated with this configuration element.
      IConfigurationElement[] getChildren()
      Returns the children of this element.
      IConfigurationExtension getConfigurationExtension()
      Gets the associated configuration extension
      java.lang.String getDescription()
      Returns the description for this configuration element
      java.io.File getFile()
      Returns the file (if there is one) associated with this configuration element.
      java.io.File getFileToReplace()
      Gets the workspace file that should be replaced as part of an import.
      ImageDescriptor getImage()
      Returns the image descriptor associated with this configuration element
      java.lang.String getName()
      Returns the name for this configuration element
      IConfigurationElement getParent()
      Gets the parent configuration element of this element.
      java.lang.String getProperty(java.lang.String key)
      Gets a property that is associated with this configuration element
      boolean hasChildren()
      Returns whether this element has children or not.
      boolean isConflicting()
      Indicates whether this new configuration conflicts with the original.
      boolean isDifferent()
      Indicates whether this new configuration is different from the original.
      boolean isSetToExport()
      Determine whether this configuration element should be exported.
      void setBuffer(java.lang.String buffer)
      Sets the buffer (if there is one) associated with this configuration element.
      void setConfigurationExtension(IConfigurationExtension extension)
      Sets the associated configuration extension
      void setConflicting(boolean flag)
      Indicates whether the new configuration conflicts with the original.
      void setDifferent(boolean flag)
      Set whether the new configuration is different from the original.
      void setFile(java.io.File file)
      Sets the file (if there is one) associated with this configuration element.
      void setFileToReplace(java.io.File file)
      Sets the workspace file that should be replaced as part of an import.
      void setParent(IConfigurationElement parent)
      Sets the parent configuration element of this element.
      void setProperty(java.lang.String key, java.lang.String value)
      Sets a property associated with this configuration element
      void setToExport(boolean flag)
      Sets whether this configuration element should be exported.
      • Methods inherited from interface java.lang.Comparable

        compareTo
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name for this configuration element
        Returns:
        the name
      • getDescription

        java.lang.String getDescription()
        Returns the description for this configuration element
        Returns:
        the description
      • getImage

        ImageDescriptor getImage()
        Returns the image descriptor associated with this configuration element
        Returns:
        the image descriptor
      • setConfigurationExtension

        void setConfigurationExtension(IConfigurationExtension extension)
        Sets the associated configuration extension
        Parameters:
        extension - the configuration extension
      • getConfigurationExtension

        IConfigurationExtension getConfigurationExtension()
        Gets the associated configuration extension
        Returns:
        the configuration extension
      • add

        void add(IConfigurationElement child)
        Add a child configuration element to this configuration element.
        Parameters:
        child - the child to add
      • hasChildren

        boolean hasChildren()
        Returns whether this element has children or not.
        Returns:
        true if this element has children.
      • getChildren

        IConfigurationElement[] getChildren()
        Returns the children of this element.
        Returns:
        the children of this element.
      • setParent

        void setParent(IConfigurationElement parent)
        Sets the parent configuration element of this element.
        Parameters:
        parent - the parent configuration element
      • getParent

        IConfigurationElement getParent()
        Gets the parent configuration element of this element.
        Returns:
        the parent configuration element.
      • setToExport

        void setToExport(boolean flag)
        Sets whether this configuration element should be exported.
        Parameters:
        flag - whether or not this configuration element should be exported.
      • isSetToExport

        boolean isSetToExport()
        Determine whether this configuration element should be exported.
        Returns:
        true if this configuration element should be exported.
      • setFile

        void setFile(java.io.File file)
        Sets the file (if there is one) associated with this configuration element.
        Parameters:
        file - the associated file
      • getFile

        java.io.File getFile()
        Returns the file (if there is one) associated with this configuration element.
        Returns:
        the file.
      • setBuffer

        void setBuffer(java.lang.String buffer)
        Sets the buffer (if there is one) associated with this configuration element.
        Parameters:
        buffer - the associated buffer
      • getBuffer

        java.lang.String getBuffer()
        Returns the buffer (if there is one) associated with this configuration element.
        Returns:
        the associated buffer.
      • setFileToReplace

        void setFileToReplace(java.io.File file)
        Sets the workspace file that should be replaced as part of an import.
        Parameters:
        file - the file to replace
      • getFileToReplace

        java.io.File getFileToReplace()
        Gets the workspace file that should be replaced as part of an import.
        Returns:
        the file to replace.
      • setDifferent

        void setDifferent(boolean flag)
        Set whether the new configuration is different from the original.
        Parameters:
        flag - true if the new configuration is different from the original,
      • isDifferent

        boolean isDifferent()
        Indicates whether this new configuration is different from the original.
        Returns:
        true if the new configuration is different from the original.
      • setConflicting

        void setConflicting(boolean flag)
        Indicates whether the new configuration conflicts with the original.
        Parameters:
        flag - true if the the new configuration is different from the original.
      • isConflicting

        boolean isConflicting()
        Indicates whether this new configuration conflicts with the original.
        Returns:
        true if the original and new configuration concflict.
      • setProperty

        void setProperty(java.lang.String key,
                         java.lang.String value)
        Sets a property associated with this configuration element
        Parameters:
        key - the key for the property
        value - the value for the property
      • getProperty

        java.lang.String getProperty(java.lang.String key)
        Gets a property that is associated with this configuration element
        Parameters:
        key - the key for the property
        Returns:
        the value or null if it does not exist