org.glassfish.jersey.message.internal.AcceptableMediaType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-common Show documentation
Show all versions of jersey-common Show documentation
Jersey core common packages
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2015 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.jersey.message.internal;
import java.text.ParseException;
import java.util.Comparator;
import java.util.Map;
import javax.ws.rs.core.MediaType;
/**
* An acceptable media type.
*
* @author Paul Sandoz
* @author Marek Potociar (marek.potociar at oracle.com)
*/
public class AcceptableMediaType extends MediaType implements Qualified {
/**
* Comparator for collections of acceptable media types.
*/
public static final Comparator COMPARATOR = new Comparator() {
@Override
public int compare(AcceptableMediaType o1, AcceptableMediaType o2) {
int i = Quality.QUALIFIED_COMPARATOR.compare(o1, o2);
if (i != 0) {
return i;
}
return MediaTypes.PARTIAL_ORDER_COMPARATOR.compare(o1, o2);
}
};
private final int q;
/**
* Create new acceptable media type instance with a {@link Quality#DEFAULT
* default quality factor} value.
*
* @param type the primary type, {@code null} is equivalent to
* {@link #MEDIA_TYPE_WILDCARD}
* @param subtype the subtype, null is equivalent to
* {@link #MEDIA_TYPE_WILDCARD}
*/
public AcceptableMediaType(String type, String subtype) {
super(type, subtype); // no need to add default quality parameter.
q = Quality.DEFAULT;
}
/**
* Create new acceptable media type instance.
*
* @param type the primary type, {@code null} is equivalent to
* {@link #MEDIA_TYPE_WILDCARD}
* @param subtype the subtype, {@code null} is equivalent to
* {@link #MEDIA_TYPE_WILDCARD}
* @param quality quality factor value in [ppt]. See {@link Qualified}.
* @param parameters a map of media type parameters, {@code null} is the same as an
* empty map.
*/
public AcceptableMediaType(String type, String subtype, int quality, Map parameters) {
super(type, subtype, Quality.enhanceWithQualityParameter(parameters, Quality.QUALITY_PARAMETER_NAME, quality));
this.q = quality;
}
// used by AcceptableMediaType.valueOf methods; no need to fix parameter map
private AcceptableMediaType(String type, String subtype, Map parameters, int quality) {
super(type, subtype, parameters);
this.q = quality;
}
@Override
public int getQuality() {
return q;
}
/**
* Create new acceptable media type instance from the supplied
* {@link HttpHeaderReader HTTP header reader}.
*
* @param reader HTTP header reader.
* @return new acceptable media type instance.
*
* @throws ParseException in case the input data parsing failed.
*/
public static AcceptableMediaType valueOf(HttpHeaderReader reader) throws ParseException {
// Skip any white space
reader.hasNext();
// Get the type
String type = reader.nextToken().toString();
String subType = "*";
// Some HTTP implements use "*" to mean "*/*"
if (reader.hasNextSeparator('/', false)) {
reader.next(false);
// Get the subtype
subType = reader.nextToken().toString();
}
Map parameters = null;
int quality = Quality.DEFAULT;
if (reader.hasNext()) {
parameters = HttpHeaderReader.readParameters(reader);
if (parameters != null) {
String v = parameters.get(Quality.QUALITY_PARAMETER_NAME);
if (v != null) {
quality = HttpHeaderReader.readQualityFactor(v);
}
}
}
// use private constructor to skip quality value validation step
return new AcceptableMediaType(type, subType, parameters, quality);
}
/**
* Create new acceptable media type instance from the supplied
* {@link javax.ws.rs.core.MediaType media type}.
*
* @param mediaType general-purpose media type.
* @return new acceptable media type instance.
*
* @throws ParseException in case the quality parameter parsing failed.
*/
public static AcceptableMediaType valueOf(MediaType mediaType) throws ParseException {
if (mediaType instanceof AcceptableMediaType) {
return (AcceptableMediaType) mediaType;
}
final Map parameters = mediaType.getParameters();
int quality = Quality.DEFAULT;
if (parameters != null) {
final String v = parameters.get(Quality.QUALITY_PARAMETER_NAME);
if (v != null) {
quality = HttpHeaderReader.readQualityFactor(v);
}
}
// use private constructor to skip quality value validation step
return new AcceptableMediaType(mediaType.getType(), mediaType.getSubtype(), parameters, quality);
}
@Override
public boolean equals(Object obj) {
if (!super.equals(obj)) {
return false;
}
if (obj instanceof AcceptableMediaType) {
final AcceptableMediaType other = (AcceptableMediaType) obj;
return this.q == other.q;
} else {
// obj is a plain MediaType instance
// with a quality factor set to default (1.0)
return this.q == Quality.DEFAULT;
}
}
@Override
public int hashCode() {
int hash = super.hashCode();
return (this.q == Quality.DEFAULT) ? hash : 47 * hash + this.q;
}
}