Package ch.ivyteam.ivy.vars

Interface Variable

  • public interface Variable
    This interface provides meta information for a variable.
    Since:
    9.2
    API:
    This is a public API.

    • Method Detail

      • name

        String name()
        Get the name of this variable.
        Returns:
        name
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • value

        String value()
        Get the actual value of this variable.
        Returns:
        actual value
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • description

        String description()
        Get the description of this variable.
        Returns:
        description
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • defaultValue

        String defaultValue()
        Get the default value of this variable.
        Returns:
        default value
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • isDefault

        boolean isDefault()
        Checks if a variable is the default or can be reseted.
        Returns:
        true if this variable is the default
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • type

        String type()
        Get the format type of this variable.
        Returns:
        format type as string (e.g: boolean, number, password)
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • enumerationValues

        List<String> enumerationValues()
        Get a list of possible values which are accepted by this variable.
        Returns:
        list of possible values
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • source

        String source()
        Get the source of this variable
        Returns:
        source as simple string
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • originSource

        String originSource()
        Get the origin source of this variable
        Returns:
        source as simple string
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.