net.morimekta.providence.descriptor

Interface PField<V>

public interface PField<V>

Field descriptor. All struct variants contains a set of fields. This interface describes the properties each field has. It is an interface so the fields themselves may be implemented as an enum.

Method Summary

Modifier and Type	Method and Description
String	getComment() The type comment is the last block of comment written before the type declaration.
V	getDefaultValue()
PDescriptor<V>	getDescriptor()
int	getKey()
String	getName()
PRequirement	getRequirement()
PType	getType()
boolean	hasDefaultValue()

Method Detail

getComment

String getComment()

The type comment is the last block of comment written before the type declaration. Comments on the same line, after the declaration is ignored.

Returns:

The comment string containing all formatting (not including the comment delimiter and the leading space.

getKey

int getKey()

Returns:

The field numeric ID or key.

getRequirement

PRequirement getRequirement()

Returns:

How the field is required for validity.

getType

PType getType()

Returns:

The data type of the field.

getDescriptor

PDescriptor<V> getDescriptor()

Returns:

The type descriptor for the field data type.

getName

String getName()

Returns:

The field name (original).

hasDefaultValue

boolean hasDefaultValue()

Returns:

Whether the field has an explicit default value.

getDefaultValue

V getDefaultValue()

Returns:

The default value or null if none. This should return value also where the field has an implicit default value, e.g. numerical types.