Enum UriTemplate.CompositeOutput

java.lang.Object
java.lang.Enum<UriTemplate.CompositeOutput>
com.google.api.client.http.UriTemplate.CompositeOutput
All Implemented Interfaces:
Serializable, Comparable<UriTemplate.CompositeOutput>
Enclosing class:
UriTemplate

private static enum UriTemplate.CompositeOutput extends Enum<UriTemplate.CompositeOutput>
Contains information on how to output a composite value.
  • Enum Constant Details

  • Field Details

    • propertyPrefix

      private final Character propertyPrefix
    • outputPrefix

      private final String outputPrefix
    • explodeJoiner

      private final String explodeJoiner
    • requiresVarAssignment

      private final boolean requiresVarAssignment
    • reservedExpansion

      private final boolean reservedExpansion
  • Constructor Details

    • CompositeOutput

      private CompositeOutput(Character propertyPrefix, String outputPrefix, String explodeJoiner, boolean requiresVarAssignment, boolean reservedExpansion)
      Parameters:
      propertyPrefix - The prefix of a parameter or null for none. In {+var} the prefix is '+'
      outputPrefix - The string that should be prefixed to the expanded template.
      explodeJoiner - The delimiter used to join composite values.
      requiresVarAssignment - Denotes whether or not the expanded template should contain an assignment with the variable.
      reservedExpansion - Reserved expansion allows pct-encoded triplets and characters in the reserved set.
  • Method Details

    • values

      public static UriTemplate.CompositeOutput[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static UriTemplate.CompositeOutput 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
    • getOutputPrefix

      String getOutputPrefix()
      Returns the string that should be prefixed to the expanded template.
    • getExplodeJoiner

      String getExplodeJoiner()
      Returns the delimiter used to join composite values.
    • requiresVarAssignment

      boolean requiresVarAssignment()
      Returns whether or not the expanded template should contain an assignment with the variable.
    • getVarNameStartIndex

      int getVarNameStartIndex()
      Returns the start index of the var name. If the variable contains a prefix the start index will be 1 else it will be 0.
    • getEncodedValue

      String getEncodedValue(String value)
      Encodes the specified value. If reserved expansion is turned on then pct-encoded triplets and characters are allowed in the reserved set.
      Parameters:
      value - The string to be encoded.
      Returns:
      The encoded string.
    • getReservedExpansion

      boolean getReservedExpansion()