com.screenscraper.http.models

Class ScrapingHttpHeader

java.lang.Object

com.screenscraper.http.models.ScrapingHttpHeader

All Implemented Interfaces:

java.lang.Comparable<ScrapingHttpHeader>

public class ScrapingHttpHeader
extends java.lang.Object
implements java.lang.Comparable<ScrapingHttpHeader>

Represents a header

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
ScrapingHttpHeader(java.lang.String name, java.lang.String value) Creates the header

Method Summary

Modifier and Type	Method and Description
int	compareTo(ScrapingHttpHeader other) Compares this object with the specified object for order.
boolean	equals(java.lang.Object o)
java.lang.String	getName() Returns the Name for the object
java.lang.String	getValue() Returns the Value for the object
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScrapingHttpHeader

public ScrapingHttpHeader(@NotNull
                          java.lang.String name,
                          @NotNull
                          java.lang.String value)

Creates the header

Parameters:

name - The name of the header (case insensitive)

value - The value of the header

Method Detail

getName

@NotNull
public java.lang.String getName()

Returns the Name for the object

Returns:

The Name for the object

getValue

@NotNull
public java.lang.String getValue()

Returns the Value for the object

Returns:

The Value for the object

compareTo

public int compareTo(@NotNull
                     ScrapingHttpHeader other)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.

It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."

In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.

Specified by:

compareTo in interface java.lang.Comparable<ScrapingHttpHeader>

Parameters:

other - the object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.NullPointerException - if the specified object is null

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this object.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object