FieldType (Providence Generator : Common 2.6.0 API)

java.lang.Object
- net.morimekta.providence.model.FieldType

All Implemented Interfaces:

Serializable, Comparable<FieldType>, Decl, FieldType_OrBuilder, net.morimekta.providence.PMessage<FieldType>, net.morimekta.providence.PMessageOrBuilder<FieldType>, net.morimekta.providence.PValue<FieldType>, net.morimekta.providence.serializer.binary.BinaryWriter, net.morimekta.util.Stringable
```
@Generated(value="net.morimekta.providence:providence-generator-java",
           comments="java:serializable")
 @Immutable
public class FieldType
extends Object
implements Decl, FieldType_OrBuilder, net.morimekta.providence.PMessage<FieldType>, Comparable<FieldType>, Serializable, net.morimekta.providence.serializer.binary.BinaryWriter
```
For fields: (<key>:)? (required|optional)? <type> <name> (= <default_value>)? For const: const <type> <name> = <default_value>
Fields without key is assigned values ranging from 65335 and down (2^16-1) in order of appearance. Because of the "in order of appearance" the field *must* be filled by the IDL parser.
Consts are always given the key '0'.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FieldType._Builder
For fields: (<key>:)?

static class FieldType._Field

Nested Classes
Modifier and Type	Class and Description
`static class`	`FieldType._Builder` For fields: (<key>:)?
`static class`	`FieldType._Field`

Field Summary

Fields
Modifier and Type Field and Description

static net.morimekta.providence.descriptor.PStructDescriptor<FieldType> kDescriptor

Fields
Modifier and Type	Field and Description
`static net.morimekta.providence.descriptor.PStructDescriptor<FieldType>`	`kDescriptor`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`asString()`
`static FieldType._Builder`	`builder()` Make a `p_model.FieldType` builder.
`int`	`compareTo(FieldType other)`
`net.morimekta.providence.descriptor.PStructDescriptor<FieldType>`	`descriptor()`
`boolean`	`equals(Object o)`
`<T> T`	`get(int key)`
`Map<String,String>`	`getAnnotations()`
`String`	`getDefaultValue()`
`String`	`getDocumentation()` Documentation for the specific declaration.
`int`	`getId()`
`String`	`getName()` Name of the type, constant or service.
`FieldRequirement`	`getRequirement()`
`String`	`getType()`
`boolean`	`has(int key)`
`boolean`	`hasAnnotations()`
`boolean`	`hasDefaultValue()`
`boolean`	`hasDocumentation()`
`int`	`hashCode()`
`boolean`	`hasId()`
`boolean`	`hasName()`
`boolean`	`hasRequirement()`
`boolean`	`hasType()`
`FieldType._Builder`	`mutate()`
`int`	`numAnnotations()`
`Optional<Map<String,String>>`	`optionalAnnotations()`
`Optional<String>`	`optionalDefaultValue()`
`Optional<String>`	`optionalDocumentation()` Documentation for the specific declaration.
`Optional<FieldRequirement>`	`optionalRequirement()`
`static net.morimekta.providence.descriptor.PStructDescriptorProvider<FieldType>`	`provider()`
`String`	`toString()`
`int`	`writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.morimekta.providence.PMessage
get, has, mergeWith

Methods inherited from interface net.morimekta.providence.PMessageOrBuilder
toBuilder, toMessage

- Field Detail
  - kDescriptor
```
public static final net.morimekta.providence.descriptor.PStructDescriptor<FieldType> kDescriptor
```
- Method Detail
  - hasDocumentation
```
public boolean hasDocumentation()
```
    Specified by:
    
    hasDocumentation in interface Decl
    
    Returns:
    
    If documentation is present.
  - getDocumentation
```
public String getDocumentation()
```
    Description copied from interface: Decl
    
    Documentation for the specific declaration.
    
    Specified by:
    
    getDocumentation in interface Decl
    
    Returns:
    
    The documentation value
  - optionalDocumentation
```
@Nonnull
public Optional<String> optionalDocumentation()
```
    Description copied from interface: Decl
    
    Documentation for the specific declaration.
    
    Specified by:
    
    optionalDocumentation in interface Decl
    
    Returns:
    
    Optional of the documentation field value.
  - hasId
```
public boolean hasId()
```
    Specified by:
    
    hasId in interface FieldType_OrBuilder
    
    Returns:
    
    If id is present.
  - getId
```
public int getId()
```
    Specified by:
    
    getId in interface FieldType_OrBuilder
    
    Returns:
    
    The id value
  - hasRequirement
```
public boolean hasRequirement()
```
    Specified by:
    
    hasRequirement in interface FieldType_OrBuilder
    
    Returns:
    
    If requirement is present.
  - getRequirement
```
public FieldRequirement getRequirement()
```
    Specified by:
    
    getRequirement in interface FieldType_OrBuilder
    
    Returns:
    
    The requirement value
  - optionalRequirement
```
@Nonnull
public Optional<FieldRequirement> optionalRequirement()
```
    Specified by:
    
    optionalRequirement in interface FieldType_OrBuilder
    
    Returns:
    
    Optional of the requirement field value.
  - hasType
```
public boolean hasType()
```
    Specified by:
    
    hasType in interface FieldType_OrBuilder
    
    Returns:
    
    If type is present.
  - getType
```
@Nonnull
public String getType()
```
    Specified by:
    
    getType in interface FieldType_OrBuilder
    
    Returns:
    
    The type value
  - hasName
```
public boolean hasName()
```
    Specified by:
    
    hasName in interface Decl
    
    Returns:
    
    If name is present.
  - getName
```
@Nonnull
public String getName()
```
    Description copied from interface: Decl
    
    Name of the type, constant or service.
    
    Specified by:
    
    getName in interface Decl
    
    Returns:
    
    The name value
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
    Specified by:
    
    hasDefaultValue in interface FieldType_OrBuilder
    
    Returns:
    
    If default_value is present.
  - getDefaultValue
```
public String getDefaultValue()
```
    Specified by:
    
    getDefaultValue in interface FieldType_OrBuilder
    
    Returns:
    
    The default_value value
  - optionalDefaultValue
```
@Nonnull
public Optional<String> optionalDefaultValue()
```
    Specified by:
    
    optionalDefaultValue in interface FieldType_OrBuilder
    
    Returns:
    
    Optional of the default_value field value.
  - numAnnotations
```
public int numAnnotations()
```
    Specified by:
    
    numAnnotations in interface FieldType_OrBuilder
    
    Returns:
    
    Number of entries in annotations.
  - hasAnnotations
```
public boolean hasAnnotations()
```
    Specified by:
    
    hasAnnotations in interface FieldType_OrBuilder
    
    Returns:
    
    If annotations is present.
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    Specified by:
    
    getAnnotations in interface FieldType_OrBuilder
    
    Returns:
    
    The annotations value
  - optionalAnnotations
```
@Nonnull
public Optional<Map<String,String>> optionalAnnotations()
```
    Specified by:
    
    optionalAnnotations in interface FieldType_OrBuilder
    
    Returns:
    
    Optional of the annotations field value.
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface net.morimekta.providence.PMessageOrBuilder<FieldType>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface net.morimekta.providence.PMessageOrBuilder<FieldType>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - asString
```
@Nonnull
public String asString()
```
    Specified by:
    
    asString in interface net.morimekta.providence.PMessage<FieldType>
    
    Specified by:
    
    asString in interface net.morimekta.util.Stringable
  - compareTo
```
public int compareTo(FieldType other)
```
    Specified by:
    
    compareTo in interface Comparable<FieldType>
  - writeBinary
```
public int writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer)
                throws IOException
```
    Specified by:
    
    writeBinary in interface net.morimekta.providence.serializer.binary.BinaryWriter
    
    Throws:
    
    IOException
  - mutate
```
@Nonnull
public FieldType._Builder mutate()
```
    Specified by:
    
    mutate in interface net.morimekta.providence.PMessage<FieldType>
  - provider
```
@Nonnull
public static net.morimekta.providence.descriptor.PStructDescriptorProvider<FieldType> provider()
```
  - descriptor
```
@Nonnull
public net.morimekta.providence.descriptor.PStructDescriptor<FieldType> descriptor()
```
    Specified by:
    
    descriptor in interface net.morimekta.providence.PMessageOrBuilder<FieldType>
    
    Specified by:
    
    descriptor in interface net.morimekta.providence.PValue<FieldType>
  - builder
```
public static FieldType._Builder builder()
```
    Make a p_model.FieldType builder.
    
    Returns:
    
    The builder instance.

Class FieldType

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.morimekta.providence.PMessage

Methods inherited from interface net.morimekta.providence.PMessageOrBuilder

Field Detail

kDescriptor

Method Detail

hasDocumentation

getDocumentation

optionalDocumentation

hasId

getId

hasRequirement

getRequirement

optionalRequirement

hasType

getType

hasName

getName

hasDefaultValue

getDefaultValue

optionalDefaultValue

numAnnotations

hasAnnotations

getAnnotations

optionalAnnotations

has

get

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder