Enum ValueGetter

  • All Implemented Interfaces:
    Serializable, Comparable<ValueGetter>

    public enum ValueGetter
    extends Enum<ValueGetter>
    Gets a value from an object that represents a parameter passed as a method argument.

    This abstraction hides the handling of Holder.

    ValueGetter is a stateless behavior encapsulation.

    Author:
    Kohsuke Kawaguchi
    • Enum Constant Detail

      • PLAIN

        public static final ValueGetter PLAIN
        ValueGetter that works for WebParam.Mode.IN parameter.

        Since it's the IN mode, the parameter is not a Holder, therefore the parameter itself is a value.

      • HOLDER

        public static final ValueGetter HOLDER
        Creates ValueGetter that works for Holder, which is WebParam.Mode.INOUT or WebParam.Mode.OUT.

        In those WebParam.Modes, the parameter is a Holder, so the value to be sent is obtained by getting the value of the holder.

    • Method Detail

      • values

        public static ValueGetter[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ValueGetter c : ValueGetter.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ValueGetter valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • get

        public abstract Object get​(Object parameter)
        Gets the value to be sent, from a parameter given as a method argument.