Package org.forgerock.api.jackson
Interface WithExampleSchema<T>
-
- Type Parameters:
T
- The type of the example.
- All Known Implementing Classes:
CrestAnySchema
,CrestArraySchema
,CrestBooleanSchema
,CrestObjectSchema
public interface WithExampleSchema<T>
Extension for CREST and OpenAPI schemas to express an example value.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description T
getExample()
Getsexample
JSON Schema field.void
setExample(String example)
Setsexample
JSON Schema field.
-
-
-
Method Detail
-
getExample
T getExample()
Getsexample
JSON Schema field.- Returns:
- The example value, or null if not defined.
-
setExample
void setExample(String example) throws IOException
Setsexample
JSON Schema field.- Parameters:
example
- The example value.- Throws:
IOException
- When the type of schema cannot be parsed from the String value.
-
-