UserType (Protostuff Compiler - Parser 3.1.40 API)

All Superinterfaces:

Descriptor, Element, FieldType, Type

All Known Implementing Classes:

Enum, Group, Message
```
public interface UserType
extends Descriptor, FieldType
```
User type is a base interface for all types that can be defined by user - messages, enums and groups.

Author:

Kostiantyn Shchepanovskyi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addReservedFieldName(String fieldName)`
`void`	`addReservedFieldRange(Range range)`
`String`	`getFullyQualifiedName()`	Returns fully qualified name for this user type.
`String`	`getName()`	Short name.
`UserTypeContainer`	`getParent()`
`Proto`	`getProto()`
`List<String>`	`getReservedFieldNames()`
`List<Range>`	`getReservedFieldRanges()`
`boolean`	`isNested()`	Test if this type is nested (declared inside of other message).
`void`	`setFullyQualifiedName(String fullyQualifiedName)`
`void`	`setName(String name)`
`void`	`setProto(Proto proto)`

Methods inherited from interface io.protostuff.compiler.model.Descriptor
getDescriptorType, getOptions

Methods inherited from interface io.protostuff.compiler.model.Element
getCommentLines, getComments, getSourceCodeLocation

Methods inherited from interface io.protostuff.compiler.model.FieldType
getCanonicalName, isEnum, isMap, isMessage, isScalar

- Method Detail
  - getName
```
String getName()
```
    Short name. For example, Baz
    
    Specified by:
    
    getName in interface Descriptor
    
    Specified by:
    
    getName in interface FieldType
    
    Specified by:
    
    getName in interface Type
  - setName
```
void setName(String name)
```
  - getProto
```
Proto getProto()
```
  - setProto
```
void setProto(Proto proto)
```
  - getFullyQualifiedName
```
String getFullyQualifiedName()
```
    Returns fully qualified name for this user type. It always starts with dot.
    
    Specified by:
    
    getFullyQualifiedName in interface FieldType
    
    Specified by:
    
    getFullyQualifiedName in interface Type
  - setFullyQualifiedName
```
void setFullyQualifiedName(String fullyQualifiedName)
```
  - getParent
```
UserTypeContainer getParent()
```
    Specified by:
    
    getParent in interface Element
  - isNested
```
boolean isNested()
```
    Test if this type is nested (declared inside of other message).
  - addReservedFieldRange
```
void addReservedFieldRange(Range range)
```
  - addReservedFieldName
```
void addReservedFieldName(String fieldName)
```
  - getReservedFieldRanges
```
List<Range> getReservedFieldRanges()
```
  - getReservedFieldNames
```
List<String> getReservedFieldNames()
```