Interface Schema.Entry
-
- All Known Implementing Classes:
Schema.Entry
- Enclosing interface:
- Schema
public static interface Schema.Entry
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Schema.Entry.Builder
Plain builder matchingSchema.Entry
structure.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description String
getComment()
<T> T
getDefaultValue()
Schema
getElementSchema()
default javax.json.JsonValue
getJsonProp(String name)
Get a property values from entry with its name.String
getName()
String
getOriginalFieldName()
String
getProp(String property)
Map<String,String>
getProps()
String
getRawName()
Schema.Type
getType()
boolean
isMetadata()
boolean
isNullable()
Schema.Entry.Builder
toBuilder()
-
-
-
Method Detail
-
getRawName
String getRawName()
- Returns:
- The raw name of this entry.
-
getOriginalFieldName
String getOriginalFieldName()
- Returns:
- the raw name of this entry if exists, else return name.
-
getType
Schema.Type getType()
- Returns:
- Type of the entry, this determine which other fields are populated.
-
isNullable
boolean isNullable()
- Returns:
- Is this entry nullable or always valued.
-
isMetadata
boolean isMetadata()
- Returns:
- true if this entry is for metadata; false for ordinary data.
-
getDefaultValue
<T> T getDefaultValue()
- Type Parameters:
T
- the default value type.- Returns:
- Default value for this entry.
-
getElementSchema
Schema getElementSchema()
- Returns:
- For type == record, the element type.
-
getComment
String getComment()
- Returns:
- Allows to associate to this field a comment - for doc purposes, no use in the runtime.
-
getProp
String getProp(String property)
- Parameters:
property
- : property name.- Returns:
- the requested metadata prop
-
getJsonProp
default javax.json.JsonValue getJsonProp(String name)
Get a property values from entry with its name.- Parameters:
name
- : property's name.- Returns:
- property's value.
-
toBuilder
Schema.Entry.Builder toBuilder()
- Returns:
- an
Schema.Entry.Builder
from this entry.
-
-