Enum Class JsonFormat.Shape
java.lang.Object
java.lang.Enum<JsonFormat.Shape>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.annotation.JsonFormat.Shape
- All Implemented Interfaces:
Serializable
,Comparable<JsonFormat.Shape>
,java.lang.constant.Constable
- Enclosing class:
- JsonFormat
Value enumeration used for indicating preferred Shape; translates
loosely to JSON types, with some extra values to indicate less precise
choices (i.e. allowing one of multiple actual shapes)
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionMarker enum value that indicates "whatever" choice, meaning that annotation does NOT specify shape to use.Value that indicates that (JSON) Array type should be used.Value that indicates that Binary type (native, if format supports it; encoding using Base64 if only textual types supported) should be used.Value that indicates that (JSON) boolean type (true, false) should be used.Marker enum value that indicates the "default" choice for given datatype; for example, JSON String forString
, or JSON Number for Java numbers.Value that indicates that a numeric (JSON) type should be used (but does not specify whether integer or floating-point representation should be used)Value that indicates that floating-point numeric type should be usedValue that indicates that integer number type should be used (and notNUMBER_FLOAT
).Value that indicates that (JSON) Object type should be used.Value that indicates that (JSON) String type should be used. -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
static JsonFormat.Shape
Returns the enum constant of this class with the specified name.static JsonFormat.Shape[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
ANY
Marker enum value that indicates "whatever" choice, meaning that annotation does NOT specify shape to use. Note that this is different fromNATURAL
, which specifically instructs use of the "natural" shape for datatype. -
NATURAL
Marker enum value that indicates the "default" choice for given datatype; for example, JSON String forString
, or JSON Number for Java numbers. Note that this is different fromANY
in that this is actual explicit choice that overrides possible default settings.- Since:
- 2.8
-
SCALAR
-
ARRAY
Value that indicates that (JSON) Array type should be used. -
OBJECT
Value that indicates that (JSON) Object type should be used. -
NUMBER
Value that indicates that a numeric (JSON) type should be used (but does not specify whether integer or floating-point representation should be used) -
NUMBER_FLOAT
Value that indicates that floating-point numeric type should be used -
NUMBER_INT
Value that indicates that integer number type should be used (and notNUMBER_FLOAT
). -
STRING
Value that indicates that (JSON) String type should be used. -
BOOLEAN
Value that indicates that (JSON) boolean type (true, false) should be used. -
BINARY
Value that indicates that Binary type (native, if format supports it; encoding using Base64 if only textual types supported) should be used.- Since:
- 2.10
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
isNumeric
public boolean isNumeric() -
isStructured
public boolean isStructured()
-