RecordType (Sponge - API 1.16.5 API)

java.lang.Object
- org.openksavi.sponge.type.DataType<Map<String,Object>>
- - org.openksavi.sponge.type.RecordType

All Implemented Interfaces:

Cloneable, Descriptive, HasFeatures
```
public class RecordType
extends DataType<Map<String,Object>>
```
A record type. This type requires a list of named record field types. A value of this type has to be an instance of Map with elements corresponding to the field names and values.

Field Summary
- Fields inherited from class org.openksavi.sponge.type.DataType
  FEATURE_FORMAT

Constructor Summary

Constructors
Constructor and Description

RecordType()

RecordType(List<DataType> fields)

RecordType(String name)

RecordType(String name, List<DataType> fields)

Constructors
Constructor and Description
`RecordType()`
`RecordType(List<DataType> fields)`
`RecordType(String name)`
`RecordType(String name, List<DataType> fields)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecordType`	`clone()`
`RecordType`	`getBaseType()`
`List<DataType>`	`getFields()`
`<T extends DataType<?>> T`	`getFieldType(String fieldName)`
`boolean`	`isInheritationApplied()`
`protected void`	`refreshFieldLookupMap()`
`void`	`setBaseType(RecordType baseType)`
`void`	`setFields(List<DataType> fields)`
`void`	`setInheritationApplied(boolean inheritationApplied)`
`RecordType`	`withAnnotated()`
`RecordType`	`withAnnotated(boolean annotated)`
`RecordType`	`withBaseType(RecordType baseType)` Sets a base record type for this type.
`RecordType`	`withDefaultValue(Map<String,Object> value)`
`RecordType`	`withDescription(String description)`
`RecordType`	`withFeature(String name, Object value)`
`RecordType`	`withFeatures(Map<String,Object> features)`
`RecordType`	`withFields(List<DataType> fields)` Adds new fields.
`RecordType`	`withFormat(String format)`
`RecordType`	`withLabel(String label)`
`RecordType`	`withName(String name)`
`RecordType`	`withNullable()`
`RecordType`	`withNullable(boolean nullable)`
`RecordType`	`withOptional()`
`RecordType`	`withProvided(ProvidedMeta provided)`
`RecordType`	`withReadOnly()`
`RecordType`	`withReadOnly(boolean readOnly)`

Methods inherited from class org.openksavi.sponge.type.DataType
getDefaultValue, getDescription, getFeatures, getFormat, getKind, getLabel, getName, getProvided, getRegisteredType, isAnnotated, isNullable, isOptional, isReadOnly, setAnnotated, setDefaultValue, setDescription, setFeatures, setFormat, setLabel, setName, setNullable, setOptional, setProvided, setReadOnly, setRegisteredType, withDefaultValue

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecordType
```
public RecordType()
```

RecordType
```
public RecordType(String name)
```

RecordType

public RecordType(List<DataType> fields)

RecordType

public RecordType(String name,
                  List<DataType> fields)

Method Detail
- withName
```
public RecordType withName(String name)
```
  Overrides:
  
  withName in class DataType<Map<String,Object>>
- withLabel
```
public RecordType withLabel(String label)
```
  Overrides:
  
  withLabel in class DataType<Map<String,Object>>
- withDescription
```
public RecordType withDescription(String description)
```
  Overrides:
  
  withDescription in class DataType<Map<String,Object>>
- withAnnotated
```
public RecordType withAnnotated(boolean annotated)
```
  Overrides:
  
  withAnnotated in class DataType<Map<String,Object>>
- withAnnotated
```
public RecordType withAnnotated()
```
  Overrides:
  
  withAnnotated in class DataType<Map<String,Object>>
- withFormat
```
public RecordType withFormat(String format)
```
  Overrides:
  
  withFormat in class DataType<Map<String,Object>>
- withFeatures
```
public RecordType withFeatures(Map<String,Object> features)
```
  Overrides:
  
  withFeatures in class DataType<Map<String,Object>>
- withFeature
```
public RecordType withFeature(String name,
                              Object value)
```
  Overrides:
  
  withFeature in class DataType<Map<String,Object>>
- withDefaultValue
```
public RecordType withDefaultValue(Map<String,Object> value)
```
  Overrides:
  
  withDefaultValue in class DataType<Map<String,Object>>
- withNullable
```
public RecordType withNullable(boolean nullable)
```
  Overrides:
  
  withNullable in class DataType<Map<String,Object>>
- withNullable
```
public RecordType withNullable()
```
  Overrides:
  
  withNullable in class DataType<Map<String,Object>>
- withReadOnly
```
public RecordType withReadOnly(boolean readOnly)
```
  Overrides:
  
  withReadOnly in class DataType<Map<String,Object>>
- withReadOnly
```
public RecordType withReadOnly()
```
  Overrides:
  
  withReadOnly in class DataType<Map<String,Object>>
- withOptional
```
public RecordType withOptional()
```
  Overrides:
  
  withOptional in class DataType<Map<String,Object>>
- withProvided
```
public RecordType withProvided(ProvidedMeta provided)
```
  Overrides:
  
  withProvided in class DataType<Map<String,Object>>
- withFields
```
public RecordType withFields(List<DataType> fields)
```
  Adds new fields. Replaces an already existing field that has the same name.
  
  Parameters:
  
  fields - the fields.
  
  Returns:
  
  this type.
- withBaseType
```
public RecordType withBaseType(RecordType baseType)
```
  Sets a base record type for this type. Used for inheritance.
  
  Parameters:
  
  baseType - the base record type.
  
  Returns:
  
  this type.
- getFields
```
public List<DataType> getFields()
```
- setFields
```
public void setFields(List<DataType> fields)
```
- getBaseType
```
public RecordType getBaseType()
```
- setBaseType
```
public void setBaseType(RecordType baseType)
```
- isInheritationApplied
```
public boolean isInheritationApplied()
```
- setInheritationApplied
```
public void setInheritationApplied(boolean inheritationApplied)
```
- refreshFieldLookupMap
```
protected void refreshFieldLookupMap()
```
- getFieldType
```
public <T extends DataType<?>> T getFieldType(String fieldName)
```
- clone
```
public RecordType clone()
```
  Overrides:
  
  clone in class DataType<Map<String,Object>>

Class RecordType

Field Summary

Fields inherited from class org.openksavi.sponge.type.DataType

Constructor Summary

Method Summary

Methods inherited from class org.openksavi.sponge.type.DataType

Methods inherited from class java.lang.Object

Constructor Detail

RecordType

RecordType

RecordType

RecordType

Method Detail

withName

withLabel

withDescription

withAnnotated

withAnnotated

withFormat

withFeatures

withFeature

withDefaultValue

withNullable

withNullable

withReadOnly

withReadOnly

withOptional

withProvided

withFields

withBaseType

getFields

setFields

getBaseType

setBaseType

isInheritationApplied

setInheritationApplied

refreshFieldLookupMap

getFieldType

clone