Class RepresentationInfo


  • @Deprecated
    public class RepresentationInfo
    extends DocumentedInfo
    Deprecated.
    Will be removed in next major release.
    Describes a variant representation for a target resource.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String identifier
      Deprecated.
      Identifier for that element.
      private MediaType mediaType
      Deprecated.
      Media type of that element.
      private java.util.List<ParameterInfo> parameters
      Deprecated.
      List of parameters.
      private java.util.List<Reference> profiles
      Deprecated.
      List of locations of one or more meta data profiles.
      private java.lang.String reference
      Deprecated.
      Reference to an representation identifier.
      private java.lang.String xmlElement
      Deprecated.
      Qualified name of the root element for this XML-based representation.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getIdentifier()
      Deprecated.
      Returns the identifier for that element.
      MediaType getMediaType()
      Deprecated.
      Returns the media type of that element.
      java.util.List<ParameterInfo> getParameters()
      Deprecated.
      Returns the list of parameters.
      java.util.List<Reference> getProfiles()
      Deprecated.
      Returns the list of locations of one or more meta data profiles.
      java.lang.String getReference()
      Deprecated.
      Returns the reference to an representation identifier.
      java.lang.String getXmlElement()
      Deprecated.
      Returns the qualified name of the root element for this XML-based representation.
      void setIdentifier​(java.lang.String identifier)
      Deprecated.
      Sets the identifier for that element.
      void setMediaType​(MediaType mediaType)
      Deprecated.
      Sets the media type of that element.
      void setParameters​(java.util.List<ParameterInfo> parameters)
      Deprecated.
      Sets the list of parameters.
      void setProfiles​(java.util.List<Reference> profiles)
      Deprecated.
      Sets the list of locations of one or more meta data profiles.
      void setReference​(java.lang.String reference)
      Deprecated.
      Sets the reference to an representation identifier.
      void setXmlElement​(java.lang.String xmlElement)
      Deprecated.
      Sets the qualified name of the root element for this XML-based representation.
      void updateNamespaces​(java.util.Map<java.lang.String,​java.lang.String> namespaces)
      Deprecated.
      Completes the given map of namespaces with the namespaces used in the documentation elements.
      void writeElement​(XmlWriter writer)
      Deprecated.
      Writes the current object as an XML element using the given SAX writer.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • identifier

        private java.lang.String identifier
        Deprecated.
        Identifier for that element.
      • mediaType

        private MediaType mediaType
        Deprecated.
        Media type of that element.
      • parameters

        private java.util.List<ParameterInfo> parameters
        Deprecated.
        List of parameters.
      • profiles

        private java.util.List<Reference> profiles
        Deprecated.
        List of locations of one or more meta data profiles.
      • reference

        private java.lang.String reference
        Deprecated.
        Reference to an representation identifier.
      • xmlElement

        private java.lang.String xmlElement
        Deprecated.
        Qualified name of the root element for this XML-based representation.
    • Constructor Detail

      • RepresentationInfo

        public RepresentationInfo()
        Deprecated.
        Constructor.
      • RepresentationInfo

        public RepresentationInfo​(DocumentationInfo documentation)
        Deprecated.
        Constructor with a single documentation element.
        Parameters:
        documentation - A single documentation element.
      • RepresentationInfo

        public RepresentationInfo​(java.util.List<DocumentationInfo> documentations)
        Deprecated.
        Constructor with a list of documentation elements.
        Parameters:
        documentations - The list of documentation elements.
      • RepresentationInfo

        public RepresentationInfo​(MediaType mediaType)
        Deprecated.
        Constructor with a media type.
        Parameters:
        mediaType - The media type of the representation.
      • RepresentationInfo

        public RepresentationInfo​(java.lang.String documentation)
        Deprecated.
        Constructor with a single documentation element.
        Parameters:
        documentation - A single documentation element.
      • RepresentationInfo

        public RepresentationInfo​(Variant variant)
        Deprecated.
        Constructor with a variant.
        Parameters:
        variant - The variant to describe.
    • Method Detail

      • getIdentifier

        public java.lang.String getIdentifier()
        Deprecated.
        Returns the identifier for that element.
        Returns:
        The identifier for that element.
      • getMediaType

        public MediaType getMediaType()
        Deprecated.
        Returns the media type of that element.
        Returns:
        The media type of that element.
      • getParameters

        public java.util.List<ParameterInfo> getParameters()
        Deprecated.
        Returns the list of parameters.
        Returns:
        The list of parameters.
      • getProfiles

        public java.util.List<Reference> getProfiles()
        Deprecated.
        Returns the list of locations of one or more meta data profiles.
        Returns:
        The list of locations of one or more meta data profiles.
      • getReference

        public java.lang.String getReference()
        Deprecated.
        Returns the reference to an representation identifier.
        Returns:
        The reference to an representation identifier.
      • getXmlElement

        public java.lang.String getXmlElement()
        Deprecated.
        Returns the qualified name of the root element for this XML-based representation.
        Returns:
        The qualified name of the root element for this XML-based representation.
      • setIdentifier

        public void setIdentifier​(java.lang.String identifier)
        Deprecated.
        Sets the identifier for that element.
        Parameters:
        identifier - The identifier for that element.
      • setMediaType

        public void setMediaType​(MediaType mediaType)
        Deprecated.
        Sets the media type of that element.
        Parameters:
        mediaType - The media type of that element.
      • setParameters

        public void setParameters​(java.util.List<ParameterInfo> parameters)
        Deprecated.
        Sets the list of parameters.
        Parameters:
        parameters - The list of parameters.
      • setProfiles

        public void setProfiles​(java.util.List<Reference> profiles)
        Deprecated.
        Sets the list of locations of one or more meta data profiles.
        Parameters:
        profiles - The list of locations of one or more meta data profiles.
      • setReference

        public void setReference​(java.lang.String reference)
        Deprecated.
        Sets the reference to an representation identifier.
        Parameters:
        reference - The reference to an representation identifier.
      • setXmlElement

        public void setXmlElement​(java.lang.String xmlElement)
        Deprecated.
        Sets the qualified name of the root element for this XML-based representation.
        Parameters:
        xmlElement - The qualified name of the root element for this XML-based representation.
      • updateNamespaces

        public void updateNamespaces​(java.util.Map<java.lang.String,​java.lang.String> namespaces)
        Deprecated.
        Description copied from class: DocumentedInfo
        Completes the given map of namespaces with the namespaces used in the documentation elements. The key is the URI of the namespace and the value, the prefix.
        Specified by:
        updateNamespaces in class DocumentedInfo
        Parameters:
        namespaces - The given map of namespaces to complete.
      • writeElement

        public void writeElement​(XmlWriter writer)
                          throws org.xml.sax.SAXException
        Deprecated.
        Writes the current object as an XML element using the given SAX writer.
        Parameters:
        writer - The SAX writer.
        Throws:
        org.xml.sax.SAXException