Top Description Fields Constructors Methods
javax.ws.rs.client

public final Class Entity<T>

extends Object
Class Inheritance
Type Parameters
<T>
entity type.
Imports
java.lang.annotation.Annotation, java.util.Arrays, .Locale, javax.ws.rs.core.Form, .MediaType, .MultivaluedMap, .Variant
Encapsulates message entity including the associated variant information.
Author
Marek Potociar

Field Summary

Modifier and TypeField and Description
private final Annotation[]
annotations

private static final Annotation[]
EMPTY_ANNOTATIONS

private final T
entity

private final Variant
variant

Constructor Summary

AccessConstructor and Description
private
Entity(final T entity, final MediaType mediaType)

private
Entity(final T entity, final Variant variant)

private
Entity(final T entity, final MediaType mediaType, Annotation[] annotations)

private
Entity(final T entity, final Variant variant, Annotation[] annotations)

Method Summary

Modifier and TypeMethod and Description
public static <
entity Java type.
T> Entity<T>

Returns:

entity instance.
entity(final T
entity data.
entity, final MediaType
entity content type.
mediaType)

Create an entity using a supplied content media type.

public static <
entity Java type.
T> Entity<T>

Returns:

entity instance.
entity(final T
entity data.
entity, final MediaType
entity content type.
mediaType, Annotation[]
entity annotations.
annotations)

Create an entity using a supplied content media type.

public static <
entity Java type.
T> Entity<T>

Returns:

entity instance.
entity(final T
entity data.
entity, final String
entity content type.
mediaType)

Create an entity using a supplied content media type.

public static <
entity Java type.
T> Entity<T>

Returns:

entity instance.
entity(final T
entity data.
entity, final Variant
entity variant information.
variant)

Create an entity using a supplied content media type.

public static <
entity Java type.
T> Entity<T>

Returns:

entity instance.
entity(final T
entity data.
entity, final Variant
entity variant information.
variant, Annotation[]
entity annotations.
annotations)

Create an entity using a supplied content media type.

public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public static Entity<Form>

Returns:

application/x-www-form-urlencoded form entity instance.
form(final Form
form data.
form)

Create an application/x-www-form-urlencoded form entity.

public static Entity<Form>

Returns:

application/x-www-form-urlencoded form entity instance.
form(final MultivaluedMap<String, String>
multivalued map representing the form data.
formData)

Create an application/x-www-form-urlencoded form entity.

public Annotation[]

Returns:

entity annotations if set, an empty annotation array if no entity annotations have been specified.
getAnnotations()

Get the entity annotations.

public String

Returns:

entity encoding.
getEncoding()

Get entity encoding.

public T

Returns:

entity data.
getEntity()

Get entity data.

public Locale

Returns:

entity language.
getLanguage()

Get entity language.

public MediaType

Returns:

entity media type.
getMediaType()

Get entity media type.

public Variant

Returns:

entity variant information.
getVariant()

Get entity variant information.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public static <
entity Java type.
T> Entity<T>

Returns:

text/html entity instance.
html(final T
entity data.
entity)

Create a text/html entity.

public static <
entity Java type.
T> Entity<T>

Returns:

application/json entity instance.
json(final T
entity data.
entity)

Create an application/json entity.

public static <
entity Java type.
T> Entity<T>

Returns:

text/plain entity instance.
text(final T
entity data.
entity)

Create a text/plain entity.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public static <
entity Java type.
T> Entity<T>

Returns:

application/xhtml+xml entity instance.
xhtml(final T
entity data.
entity)

Create an application/xhtml+xml entity.

public static <
entity Java type.
T> Entity<T>

Returns:

application/xml entity instance.
xml(final T
entity data.
entity)

Create an application/xml entity.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

annotationsback to summary
private final Annotation[] annotations
EMPTY_ANNOTATIONSback to summary
private static final Annotation[] EMPTY_ANNOTATIONS
entityback to summary
private final T entity
variantback to summary
private final Variant variant

Constructor Detail

Entityback to summary
private Entity(final T entity, final MediaType mediaType)
Entityback to summary
private Entity(final T entity, final Variant variant)
Entityback to summary
private Entity(final T entity, final MediaType mediaType, Annotation[] annotations)
Entityback to summary
private Entity(final T entity, final Variant variant, Annotation[] annotations)

Method Detail

entityback to summary
public static <T> Entity<T> entity(final T entity, final MediaType mediaType)

Create an entity using a supplied content media type.

Parameters
<T>
entity Java type.
entity:T

entity data.

mediaType:MediaType

entity content type.

Returns:Entity<T>

entity instance.

entityback to summary
public static <T> Entity<T> entity(final T entity, final MediaType mediaType, Annotation[] annotations)

Create an entity using a supplied content media type.

Parameters
<T>
entity Java type.
entity:T

entity data.

mediaType:MediaType

entity content type.

annotations:Annotation[]

entity annotations.

Returns:Entity<T>

entity instance.

entityback to summary
public static <T> Entity<T> entity(final T entity, final String mediaType)

Create an entity using a supplied content media type.

Parameters
<T>
entity Java type.
entity:T

entity data.

mediaType:String

entity content type.

Returns:Entity<T>

entity instance.

Exceptions
IllegalArgumentException:
if the supplied string cannot be parsed or is null.
entityback to summary
public static <T> Entity<T> entity(final T entity, final Variant variant)

Create an entity using a supplied content media type.

Parameters
<T>
entity Java type.
entity:T

entity data.

variant:Variant

entity variant information.

Returns:Entity<T>

entity instance.

entityback to summary
public static <T> Entity<T> entity(final T entity, final Variant variant, Annotation[] annotations)

Create an entity using a supplied content media type.

Parameters
<T>
entity Java type.
entity:T

entity data.

variant:Variant

entity variant information.

annotations:Annotation[]

entity annotations.

Returns:Entity<T>

entity instance.

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
formback to summary
public static Entity<Form> form(final Form form)

Create an application/x-www-form-urlencoded form entity.

Parameters
form:Form

form data.

Returns:Entity<Form>

application/x-www-form-urlencoded form entity instance.

formback to summary
public static Entity<Form> form(final MultivaluedMap<String, String> formData)

Create an application/x-www-form-urlencoded form entity.

Parameters
formData:MultivaluedMap<String, String>

multivalued map representing the form data.

Returns:Entity<Form>

application/x-www-form-urlencoded form entity instance.

getAnnotationsback to summary
public Annotation[] getAnnotations()

Get the entity annotations.

Returns:Annotation[]

entity annotations if set, an empty annotation array if no entity annotations have been specified.

getEncodingback to summary
public String getEncoding()

Get entity encoding.

Returns:String

entity encoding.

getEntityback to summary
public T getEntity()

Get entity data.

Returns:T

entity data.

getLanguageback to summary
public Locale getLanguage()

Get entity language.

Returns:Locale

entity language.

getMediaTypeback to summary
public MediaType getMediaType()

Get entity media type.

Returns:MediaType

entity media type.

getVariantback to summary
public Variant getVariant()

Get entity variant information.

Returns:Variant

entity variant information.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
htmlback to summary
public static <T> Entity<T> html(final T entity)

Create a text/html entity.

Parameters
<T>
entity Java type.
entity:T

entity data.

Returns:Entity<T>

text/html entity instance.

jsonback to summary
public static <T> Entity<T> json(final T entity)

Create an application/json entity.

Parameters
<T>
entity Java type.
entity:T

entity data.

Returns:Entity<T>

application/json entity instance.

textback to summary
public static <T> Entity<T> text(final T entity)

Create a text/plain entity.

Parameters
<T>
entity Java type.
entity:T

entity data.

Returns:Entity<T>

text/plain entity instance.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
xhtmlback to summary
public static <T> Entity<T> xhtml(final T entity)

Create an application/xhtml+xml entity.

Parameters
<T>
entity Java type.
entity:T

entity data.

Returns:Entity<T>

application/xhtml+xml entity instance.

xmlback to summary
public static <T> Entity<T> xml(final T entity)

Create an application/xml entity.

Parameters
<T>
entity Java type.
entity:T

entity data.

Returns:Entity<T>

application/xml entity instance.