com.helger.http

Class AcceptEncodingList

java.lang.Object

com.helger.http.AbstractQValueList<String>

com.helger.http.AcceptEncodingList

All Implemented Interfaces:

Serializable

@NotThreadSafe
public class AcceptEncodingList
extends AbstractQValueList<String>

Contains a list of Accept-Encoding values as specified by the HTTP header

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from class com.helger.http.AbstractQValueList

m_aMap

Constructor Summary

Constructors

Constructor and Description
AcceptEncodingList()

Method Summary

Modifier and Type	Method and Description
void	addEncoding(String sEncoding, double dQuality)
boolean	explicitlySupportsEncoding(String sEncoding)
double	getQualityOfEncoding(String sEncoding) Return the associated quality of the given encoding.
QValue	getQValueOfEncoding(String sEncoding) Return the associated quality of the given encoding.
String	getUsedCompressEncoding()
String	getUsedDeflateEncoding()
String	getUsedGZIPEncoding()
boolean	supportsCompress()
boolean	supportsDeflate()
boolean	supportsEncoding(String sEncoding) Check if the passed encoding is supported.
boolean	supportsGZIP()

Methods inherited from class com.helger.http.AbstractQValueList

getAllQValues, getAllQValuesGreaterOrEqual, getAllQValuesGreaterThan, getAllQValuesLowerOrEqual, getAllQValuesLowerThan, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AcceptEncodingList

public AcceptEncodingList()

Method Detail

addEncoding

public void addEncoding(@Nonnull
                        String sEncoding,
                        @Nonnegative
                        double dQuality)

getQValueOfEncoding

@Nonnull
public QValue getQValueOfEncoding(@Nonnull
                                            String sEncoding)

Return the associated quality of the given encoding.

Parameters:

sEncoding - The encoding name to query. May not be null.

Returns:

The matching QValue and never null.

getQualityOfEncoding

public double getQualityOfEncoding(@Nonnull
                                   String sEncoding)

Return the associated quality of the given encoding.

Parameters:

sEncoding - The encoding name to query. May not be null.

Returns:

0 means not accepted, 1 means fully accepted.

supportsEncoding

public boolean supportsEncoding(@Nonnull
                                String sEncoding)

Check if the passed encoding is supported. Supported means the quality is > 0.

Parameters:

sEncoding - The encoding to be checked. May not be null.

Returns:

true if the encoding is supported, false if not.

explicitlySupportsEncoding

public boolean explicitlySupportsEncoding(@Nonnull
                                          String sEncoding)

supportsGZIP

public boolean supportsGZIP()

getUsedGZIPEncoding

@Nullable
public String getUsedGZIPEncoding()

Returns:

the accepted GZip encoding. May either be AcceptEncodingHandler.GZIP_ENCODING or AcceptEncodingHandler.X_GZIP_ENCODING or null

supportsDeflate

public boolean supportsDeflate()

getUsedDeflateEncoding

@Nullable
public String getUsedDeflateEncoding()

Returns:

the accepted GZip encoding. May either be AcceptEncodingHandler.DEFLATE_ENCODING or null

supportsCompress

public boolean supportsCompress()

getUsedCompressEncoding

@Nullable
public String getUsedCompressEncoding()

Returns:

the accepted GZip encoding. May either be AcceptEncodingHandler.COMPRESS_ENCODING or AcceptEncodingHandler.X_COMPRESS_ENCODING or null