StringRange (Apache Juneau 8.1.3)

java.lang.Object
- org.apache.juneau.http.StringRange

All Implemented Interfaces:

Comparable<StringRange>
```
@BeanIgnore
public final class StringRange
extends Object
implements Comparable<StringRange>
```
Represents a single value in a comma-delimited header value that optionally contains a quality metric for comparison and extension parameters.
Similar in concept to MediaTypeRange except instead of media types (e.g. "text/json"), it's a simple type (e.g. "iso-8601").
An example of a type range is a value in an Accept-Encoding header.
- Hypertext Transfer Protocol -- HTTP/1.1

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(StringRange o)` Compares two MediaRanges for equality.
`boolean`	`equals(Object o)` Returns true if the specified object is also a MediaType, and has the same qValue, type, parameters, and extensions.
`Map<String,Set<String>>`	`getExtensions()` Returns the optional set of custom extensions defined for this type.
`Float`	`getQValue()` Returns the 'q' (quality) value for this type, as described in Section 3.9 of RFC2616.
`String`	`getType()` Returns the type enclosed by this type range.
`int`	`hashCode()` Returns a hash based on this instance's media-type.
`boolean`	`matches(String type)` Checks if the specified type matches this range.
`static StringRange[]`	`parse(String value)` Parses a header such as an Accept-Encoding header value into an array of type ranges.
`String`	`toString()` Provides a string representation of this media range, suitable for use as an Accept header value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - parse
```
public static StringRange[] parse(String value)
```
    Parses a header such as an Accept-Encoding header value into an array of type ranges.
    The syntax expected to be found in the referenced value complies with the syntax described in RFC2616, Section 14.1, as described below:
    Accept-Encoding = "Accept-Encoding" ":" 1#( codings [ ";" "q" "=" qvalue ] ) codings = ( content-coding | "*" )
    
    Examples of its use are:
    Accept-Encoding: compress, gzip Accept-Encoding: Accept-Encoding: * Accept-Encoding: compress;q=0.5, gzip;q=1.0 Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0
    
    Parameters:
    
    value - The value to parse. If null or empty, returns a single TypeRange is returned that represents all types.
    
    Returns:
    
    The type ranges described by the string.
    The ranges are sorted such that the most acceptable type is available at ordinal position '0', and the least acceptable at position n-1.
  - getType
```
public String getType()
```
    Returns the type enclosed by this type range.
    Examples:
    - "compress"
    - "gzip"
    - "*"
    Returns:
    
    The type of this type range, lowercased, never null.
  - getQValue
```
public Float getQValue()
```
    Returns the 'q' (quality) value for this type, as described in Section 3.9 of RFC2616.
    The quality value is a float between 0.0 (unacceptable) and 1.0 (most acceptable).
    If 'q' value doesn't make sense for the context (e.g. this range was extracted from a "content-*" header, as opposed to "accept-*" header, its value will always be "1".
    
    Returns:
    
    The 'q' value for this type, never null.
  - getExtensions
```
public Map<String,Set<String>> getExtensions()
```
    Returns the optional set of custom extensions defined for this type.
    Values are lowercase and never null.
    
    Returns:
    
    The optional list of extensions, never null.
  - toString
```
public String toString()
```
    Provides a string representation of this media range, suitable for use as an Accept header value.
    The literal text generated will be all lowercase.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A media range suitable for use as an Accept header value, never null.
  - equals
```
public boolean equals(Object o)
```
    Returns true if the specified object is also a MediaType, and has the same qValue, type, parameters, and extensions.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if object is equivalent.
  - hashCode
```
public int hashCode()
```
    Returns a hash based on this instance's media-type.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    A hash based on this instance's media-type.
  - compareTo
```
public int compareTo(StringRange o)
```
    Compares two MediaRanges for equality.
    The values are first compared according to qValue values. Should those values be equal, the type is then lexicographically compared (case-insensitive) in ascending order, with the "*" type demoted last in that order. TypeRanges with the same types but with extensions are promoted over those same types with no extensions.
    
    Specified by:
    
    compareTo in interface Comparable<StringRange>
    
    Parameters:
    
    o - The range to compare to. Never null.
  - matches
```
public boolean matches(String type)
```
    Checks if the specified type matches this range.
    The type will match this range if the range type string is the same or "*".
    
    Parameters:
    
    type - The type to match against this range.
    
    Returns:
    
    true if the specified type matches this range.

Class StringRange

Method Summary

Methods inherited from class java.lang.Object

Method Detail

parse

getType

Examples:

getQValue

getExtensions

toString

equals

hashCode

compareTo

matches