-
- All Superinterfaces:
MetadataType
- All Known Implementing Classes:
DefaultObjectType
public interface ObjectType extends MetadataType
An object type represents a list of fields that is represented by key value pairs type.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Optional<ObjectFieldType>getFieldByName(String propertyName)Searches a field that matches the specified nameCollection<ObjectFieldType>getFields()The collection of all the fieldsOptional<MetadataType>getOpenRestriction()Returns the restriction if any specified for the open type.default booleanisOpen()If this object allows additional properties that are not being described in the list of fields.booleanisOrdered()If the list of fields must respect the order or not-
Methods inherited from interface org.mule.metadata.api.model.MetadataType
accept, getAnnotation, getAnnotations, getDescription, getMetadataFormat
-
-
-
-
Method Detail
-
isOpen
default boolean isOpen()
If this object allows additional properties that are not being described in the list of fields.- Returns:
- True if open
-
getOpenRestriction
Optional<MetadataType> getOpenRestriction()
Returns the restriction if any specified for the open type. This restriction applies to the type of the object's fields.- Returns:
- The restriction if any
-
getFields
Collection<ObjectFieldType> getFields()
The collection of all the fields- Returns:
- The object fields
-
isOrdered
boolean isOrdered()
If the list of fields must respect the order or not- Returns:
- True if they must be ordered
-
getFieldByName
Optional<ObjectFieldType> getFieldByName(String propertyName)
Searches a field that matches the specified name- Parameters:
propertyName- The name of the property- Returns:
- The field is any
-
-