Package org.apache.sling.hapi
Interface HApiType
-
@ProviderType public interface HApiType
A Hypermedia API type.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map<java.lang.String,HApiProperty>
getAllProperties()
A map with the names of the properties as keys and the HApiProperty object as values defined for this type, including the properties inherited from the parent typejava.lang.String
getDescription()
The description of this typejava.lang.String
getFqdn()
The fully qualified domain name of this typejava.lang.String
getName()
The name of this typejava.util.List<java.lang.String>
getParameters()
A list ofString
representing java-like generic types that can be used as types for the properties belonging to this typeHApiType
getParent()
Returns the parent type objectjava.lang.String
getPath()
The path of the Resource representing this typejava.util.Map<java.lang.String,HApiProperty>
getProperties()
A map with the names of the properties as keys and the HApiProperty object as values defined for this typejava.lang.String
getUrl()
The external URL of the node representing this typeboolean
isAbstract()
Whether this type is abstract or not.
-
-
-
Method Detail
-
getName
java.lang.String getName()
The name of this type- Returns:
-
getDescription
java.lang.String getDescription()
The description of this type- Returns:
-
getPath
java.lang.String getPath()
The path of the Resource representing this type- Returns:
-
getUrl
java.lang.String getUrl()
The external URL of the node representing this type- Returns:
-
getFqdn
java.lang.String getFqdn()
The fully qualified domain name of this type- Returns:
-
getParameters
java.util.List<java.lang.String> getParameters()
A list ofString
representing java-like generic types that can be used as types for the properties belonging to this type- Returns:
-
getProperties
java.util.Map<java.lang.String,HApiProperty> getProperties()
A map with the names of the properties as keys and the HApiProperty object as values defined for this typeThis list does not include properties inherited from the parent type
- Returns:
-
getAllProperties
java.util.Map<java.lang.String,HApiProperty> getAllProperties()
A map with the names of the properties as keys and the HApiProperty object as values defined for this type, including the properties inherited from the parent type- Returns:
-
getParent
HApiType getParent()
Returns the parent type object- Returns:
-
isAbstract
boolean isAbstract()
Whether this type is abstract or not. An abstract type is an identifier that does not map to a jcr node as a path or as a FQDN- Returns:
-
-