Interface PropertyDescription
-
@ProviderType public interface PropertyDescription
A description of a property defined in the model.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getName()
Get the name of the property.ApiProperty.SCOPE
getScope()
The scope of the property.java.lang.Object
getValue()
Get the value of the property.
-
-
-
Method Detail
-
getName
@Nonnull java.lang.String getName()
Get the name of the property.- Returns:
- The name of the property.
-
getValue
@CheckForNull java.lang.Object getValue()
Get the value of the property.- Returns:
- The property value.
-
getScope
@Nonnull ApiProperty.SCOPE getScope()
The scope of the property. The scope can be used to decide when to serialize the property. Whether it is serialized for a main entity, a child entity or both.- Returns:
- The property's scope.
-
-