Package org.forgerock.api.models

Class Parameter

  • public final class Parameter
extends Object
    Class that represents the Parameter type in API descriptor.

    • Method Detail

      • getName

        public String getName()
        Getter of the name of the parameter.
        Returns:
        Parameter name

      • getType

        public String getType()
        Getter of the parameter type.
        Returns:
        Parameter type

      • getDefaultValue

        public String getDefaultValue()
        Getter of the parameter's default value.
        Returns:
        Parameter default value

      • getDescription

        public LocalizableString getDescription()
        Getter of the parameter description.
        Returns:
        Parameter description

      • getSource

        public ParameterSource getSource()
        Getter of the parameter source.
        Returns:
        Parameter source enum

      • isRequired

        public Boolean isRequired()
        Getter of the required property.
        Returns:
        Required

      • getEnumValues

        public String[] getEnumValues()
        Getter of required enum-values.
        Returns:
        Required enum-values or null

      • getEnumTitles

        public String[] getEnumTitles()
        Getter of enum-titles.
        Returns:
        Enum-titles or null

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • parameter

        public static Parameter.Builder parameter()
        New parameter builder.
        Returns:
        Builder

      • fromAnnotation

        public static Parameter fromAnnotation​(Class<?> type,
                                       Parameter parameter)
        Builds a Parameter object from the data in the annotation.
        Parameters:
        type - The type to resolve LocalizableStrings from.
        parameter - The annotation that holds the data
        Returns:
        Parameter instance