Class AcceptableMediaType

  • All Implemented Interfaces:
    Qualified

    public class AcceptableMediaType
    extends javax.ws.rs.core.MediaType
    implements Qualified
    An acceptable media type.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.Comparator<AcceptableMediaType> COMPARATOR
      Comparator for collections of acceptable media types.
      private int q  
      • Fields inherited from class javax.ws.rs.core.MediaType

        APPLICATION_ATOM_XML, APPLICATION_ATOM_XML_TYPE, APPLICATION_FORM_URLENCODED, APPLICATION_FORM_URLENCODED_TYPE, APPLICATION_JSON, APPLICATION_JSON_PATCH_JSON, APPLICATION_JSON_PATCH_JSON_TYPE, APPLICATION_JSON_TYPE, APPLICATION_OCTET_STREAM, APPLICATION_OCTET_STREAM_TYPE, APPLICATION_SVG_XML, APPLICATION_SVG_XML_TYPE, APPLICATION_XHTML_XML, APPLICATION_XHTML_XML_TYPE, APPLICATION_XML, APPLICATION_XML_TYPE, CHARSET_PARAMETER, MEDIA_TYPE_WILDCARD, MULTIPART_FORM_DATA, MULTIPART_FORM_DATA_TYPE, SERVER_SENT_EVENTS, SERVER_SENT_EVENTS_TYPE, TEXT_HTML, TEXT_HTML_TYPE, TEXT_PLAIN, TEXT_PLAIN_TYPE, TEXT_XML, TEXT_XML_TYPE, WILDCARD, WILDCARD_TYPE
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        AcceptableMediaType​(java.lang.String type, java.lang.String subtype)
      Create new acceptable media type instance with a default quality factor value.
        AcceptableMediaType​(java.lang.String type, java.lang.String subtype, int quality, java.util.Map<java.lang.String,​java.lang.String> parameters)
      Create new acceptable media type instance.
      private AcceptableMediaType​(java.lang.String type, java.lang.String subtype, java.util.Map<java.lang.String,​java.lang.String> parameters, int quality)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      int getQuality()
      Get quality factor value (in [ppt]).
      int hashCode()  
      static AcceptableMediaType valueOf​(javax.ws.rs.core.MediaType mediaType)
      Create new acceptable media type instance from the supplied media type.
      static AcceptableMediaType valueOf​(HttpHeaderReader reader)
      Create new acceptable media type instance from the supplied HTTP header reader.
      • Methods inherited from class javax.ws.rs.core.MediaType

        getParameters, getSubtype, getType, isCompatible, isWildcardSubtype, isWildcardType, toString, valueOf, withCharset
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • COMPARATOR

        public static final java.util.Comparator<AcceptableMediaType> COMPARATOR
        Comparator for collections of acceptable media types.
      • q

        private final int q
    • Constructor Detail

      • AcceptableMediaType

        public AcceptableMediaType​(java.lang.String type,
                                   java.lang.String subtype)
        Create new acceptable media type instance with a default quality factor value.
        Parameters:
        type - the primary type, null is equivalent to MediaType.MEDIA_TYPE_WILDCARD
        subtype - the subtype, null is equivalent to MediaType.MEDIA_TYPE_WILDCARD
      • AcceptableMediaType

        public AcceptableMediaType​(java.lang.String type,
                                   java.lang.String subtype,
                                   int quality,
                                   java.util.Map<java.lang.String,​java.lang.String> parameters)
        Create new acceptable media type instance.
        Parameters:
        type - the primary type, null is equivalent to MediaType.MEDIA_TYPE_WILDCARD
        subtype - the subtype, null is equivalent to MediaType.MEDIA_TYPE_WILDCARD
        quality - quality factor value in [ppt]. See Qualified.
        parameters - a map of media type parameters, null is the same as an empty map.
      • AcceptableMediaType

        private AcceptableMediaType​(java.lang.String type,
                                    java.lang.String subtype,
                                    java.util.Map<java.lang.String,​java.lang.String> parameters,
                                    int quality)
    • Method Detail

      • getQuality

        public int getQuality()
        Description copied from interface: Qualified
        Get quality factor value (in [ppt]).
        Specified by:
        getQuality in interface Qualified
        Returns:
        quality factor value.
      • valueOf

        public static AcceptableMediaType valueOf​(HttpHeaderReader reader)
                                           throws java.text.ParseException
        Create new acceptable media type instance from the supplied HTTP header reader.
        Parameters:
        reader - HTTP header reader.
        Returns:
        new acceptable media type instance.
        Throws:
        java.text.ParseException - in case the input data parsing failed.
      • valueOf

        public static AcceptableMediaType valueOf​(javax.ws.rs.core.MediaType mediaType)
                                           throws java.text.ParseException
        Create new acceptable media type instance from the supplied media type.
        Parameters:
        mediaType - general-purpose media type.
        Returns:
        new acceptable media type instance.
        Throws:
        java.text.ParseException - in case the quality parameter parsing failed.
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class javax.ws.rs.core.MediaType
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class javax.ws.rs.core.MediaType