public class RepresentationInfo extends DocumentedInfo
Constructor and Description |
---|
RepresentationInfo()
Constructor.
|
RepresentationInfo(DocumentationInfo documentation)
Constructor with a single documentation element.
|
RepresentationInfo(List<DocumentationInfo> documentations)
Constructor with a list of documentation elements.
|
RepresentationInfo(MediaType mediaType)
Constructor with a media type.
|
RepresentationInfo(String documentation)
Constructor with a single documentation element.
|
RepresentationInfo(Variant variant)
Constructor with a variant.
|
Modifier and Type | Method and Description |
---|---|
String |
getIdentifier()
Returns the identifier for that element.
|
MediaType |
getMediaType()
Returns the media type of that element.
|
List<ParameterInfo> |
getParameters()
Returns the list of parameters.
|
List<Reference> |
getProfiles()
Returns the list of locations of one or more meta data profiles.
|
String |
getReference()
Returns the reference to an representation identifier.
|
String |
getXmlElement()
Returns the qualified name of the root element for this XML-based
representation.
|
void |
setIdentifier(String identifier)
Sets the identifier for that element.
|
void |
setMediaType(MediaType mediaType)
Sets the media type of that element.
|
void |
setParameters(List<ParameterInfo> parameters)
Sets the list of parameters.
|
void |
setProfiles(List<Reference> profiles)
Sets the list of locations of one or more meta data profiles.
|
void |
setReference(String reference)
Sets the reference to an representation identifier.
|
void |
setXmlElement(String xmlElement)
Sets the qualified name of the root element for this XML-based
representation.
|
void |
updateNamespaces(Map<String,String> namespaces)
Completes the given map of namespaces with the namespaces used in the
documentation elements.
|
void |
writeElement(XmlWriter writer)
Writes the current object as an XML element using the given SAX writer.
|
getDocumentations, resolveNamespaces, setDocumentation, setDocumentation, setDocumentations
public RepresentationInfo()
public RepresentationInfo(DocumentationInfo documentation)
documentation
- A single documentation element.public RepresentationInfo(List<DocumentationInfo> documentations)
documentations
- The list of documentation elements.public RepresentationInfo(MediaType mediaType)
mediaType
- The media type of the representation.public RepresentationInfo(String documentation)
documentation
- A single documentation element.public RepresentationInfo(Variant variant)
variant
- The variant to describe.public String getIdentifier()
public MediaType getMediaType()
public List<ParameterInfo> getParameters()
public List<Reference> getProfiles()
public String getReference()
public String getXmlElement()
public void setIdentifier(String identifier)
identifier
- The identifier for that element.public void setMediaType(MediaType mediaType)
mediaType
- The media type of that element.public void setParameters(List<ParameterInfo> parameters)
parameters
- The list of parameters.public void setProfiles(List<Reference> profiles)
profiles
- The list of locations of one or more meta data profiles.public void setReference(String reference)
reference
- The reference to an representation identifier.public void setXmlElement(String xmlElement)
xmlElement
- The qualified name of the root element for this XML-based
representation.public void updateNamespaces(Map<String,String> namespaces)
DocumentedInfo
updateNamespaces
in class DocumentedInfo
namespaces
- The given map of namespaces to complete.public void writeElement(XmlWriter writer) throws SAXException
writer
- The SAX writer.SAXException
Copyright © 2005–2013. All rights reserved.