Package com.damnhandy.uri.template.impl

Enum Operator

  • All Implemented Interfaces:
    Serializable, Comparable<Operator>
    public enum Operator
extends Enum<Operator>

    An enum representing an operator in a URI Template. 

      .------------------------------------------------------------------.
  |          NUL     +      .       /       ;      ?      &      #   |
  |------------------------------------------------------------------|
  | first |  ""     ""     "."     "/"     ";"    "?"    "&"    "#"  |
  | sep   |  ","    ","    "."     "/"     ";"    "&"    "&"    ","  |
  | named | false  false  false   false   true   true   true   false |
  | ifemp |  ""     ""     ""      ""      ""     "="    "="    ""   |
  | allow |   U     U+R     U       U       U      U      U     U+R  |
  `------------------------------------------------------------------'
    Version:
    $Revision: 1.1 $
    Author:
    Ryan J. McDonough

    • Enum Constant Detail

      • RESERVED

        public static final Operator RESERVED

      • NAME_LABEL

        public static final Operator NAME_LABEL

      • PATH

        public static final Operator PATH

      • MATRIX

        public static final Operator MATRIX

      • QUERY

        public static final Operator QUERY

      • CONTINUATION

        public static final Operator CONTINUATION

      • FRAGMENT

        public static final Operator FRAGMENT

    • Method Detail

      • values

        public static Operator[] 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 (Operator c : Operator.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Operator 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

      • getOperator

        public String getOperator()

      • getSeparator

        public String getSeparator()

      • isNamed

        public boolean isNamed()
        Returns:
        tbd

      • getListSeparator

        public String getListSeparator()

      • useVarNameWhenExploded

        public boolean useVarNameWhenExploded()
        When the variable is a Collection, this flag determines if we use the VarSpec name to prefix values. For example: {&apm;list} return false {&apm;list*} will return true
        Returns:
        tbd

      • getPrefix

        public String getPrefix()
        Returns:
        the prefix