Package org.eclipse.ant.core

Class Property

  • public class Property
extends java.lang.Object
    Represents a Ant property. Clients may instantiate this class; it is not intended to be subclassed.
    Since:
    2.1
    Restriction:
    This class is not intended to be subclassed by clients.

    • Constructor Summary

      Constructors 
      Constructor Description
      Property()  
      Property​(java.lang.String name, java.lang.String value)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)  
      java.lang.String getName()
      Gets the name
      java.lang.String getPluginLabel()
      Returns the label of the plug-in that contributed this Ant property via an extension point.
      java.lang.String getValue()
      Returns the value.
      java.lang.String getValue​(boolean substituteVariables)
      Returns the value.
      int hashCode()  
      boolean isDefault()
      Returns whether this Ant property has been created because of an extension point definition.
      boolean isEclipseRuntimeRequired()
      Returns whether this property requires the Eclipse runtime to be relevant.
      void setEclipseRuntimeRequired​(boolean eclipseRuntime)  
      void setName​(java.lang.String name)
      Sets the name
      void setPluginLabel​(java.lang.String pluginLabel)
      Sets the label of the plug-in that contributed this Ant property via an extension point.
      void setValue​(java.lang.String value)
      Sets the value.
      void setValueProvider​(java.lang.String className, java.lang.ClassLoader loader)
      Sets the name of the class that is an IAntPropertyValueProvider to be used to dynamically provide a value for this property.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Property

        public Property​(java.lang.String name,
                java.lang.String value)

      • Property

        public Property()

    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the name
        Returns:
        Returns a String

      • setName

        public void setName​(java.lang.String name)
        Sets the name
        Parameters:
        name - The name to set

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getValue

        public java.lang.String getValue()
        Returns the value. Equivalent to calling #getValue(true);
        Returns:
        String

      • getValue

        public java.lang.String getValue​(boolean substituteVariables)
        Returns the value.
        Parameters:
        substituteVariables - whether the value has any variables resolved.
        Returns:
        String
        Since:
        3.0

      • setValue

        public void setValue​(java.lang.String value)
        Sets the value.
        Parameters:
        value - The value to set

      • isDefault

        public boolean isDefault()
        Returns whether this Ant property has been created because of an extension point definition.
        Returns:
        boolean
        Since:
        3.0

      • setPluginLabel

        public void setPluginLabel​(java.lang.String pluginLabel)
        Sets the label of the plug-in that contributed this Ant property via an extension point.
        Parameters:
        pluginLabel - The label of the plug-in
        Since:
        3.0

      • getPluginLabel

        public java.lang.String getPluginLabel()
        Returns the label of the plug-in that contributed this Ant property via an extension point.
        Returns:
        pluginLabel The label of the plug-in
        Since:
        3.0

      • setValueProvider

        public void setValueProvider​(java.lang.String className,
                             java.lang.ClassLoader loader)
        Sets the name of the class that is an IAntPropertyValueProvider to be used to dynamically provide a value for this property. Sets the class loader to load the IAntPropertyValueProvider to be used to dynamically provide a value for this property.
        Parameters:
        className - The name of the value provider class to use to resolve the value of this property
        loader - The class loader to use to load the value provider class to use to resolve the value of this property
        Since:
        3.0

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • isEclipseRuntimeRequired

        public boolean isEclipseRuntimeRequired()
        Returns whether this property requires the Eclipse runtime to be relevant. Defaults value is true
        Returns:
        whether this property requires the Eclipse runtime
        Since:
        3.0

      • setEclipseRuntimeRequired

        public void setEclipseRuntimeRequired​(boolean eclipseRuntime)