Package org.springframework.data.rest.webmvc.support

Class ETag

java.lang.Object

org.springframework.data.rest.webmvc.support.ETag

public final class ETag
extends Object

A value object to represent ETags.

Author:

Oliver Gierke, Dario Seidl

Field Summary

Fields

Modifier and Type	Field	Description
static final ETag	NO_ETAG

Method Summary

Modifier and Type	Method	Description
HttpHeaders	addTo(HttpHeaders headers)	Adds the current ETag to the given headers.
boolean	equals(Object o)
static ETag	from(String value)	Creates a new ETag for the given String value.
static ETag	from(Optional<String> value)
static ETag	from(PersistentEntity<?,? extends PersistentProperty<?>> entity, Object bean)	Creates a new ETag from the given PersistentEntity and target bean.
static ETag	from(PersistentEntityResource resource)	Creates a new ETag for the given PersistentEntityResource.
int	hashCode()
boolean	matches(PersistentEntity<?,?> entity, Object target)	Returns whether the ETag matches the given PersistentEntity and target.
String	toString()
void	verify(PersistentEntity<?,?> entity, Object target)	Verifies the ETag to be created for the given target bean with the current one and raises a ETagDoesntMatchException in case they don't match.

Methods inherited from class java.lang.Object

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

Field Details

NO_ETAG

public static final ETag NO_ETAG

Method Details

from

public static ETag from(String value)

Creates a new ETag for the given String value. Falls back to NO_ETAG in case null is provided.

Parameters:

value - the source ETag value, must not be null.

Returns:

from

public static ETag from(Optional<String> value)

from

public static ETag from(PersistentEntityResource resource)

Creates a new ETag for the given PersistentEntityResource.

Parameters:

resource - must not be null.

Returns:

from

public static ETag from(PersistentEntity<?,? extends PersistentProperty<?>> entity,
 Object bean)

Creates a new ETag from the given PersistentEntity and target bean.

Parameters:

entity - must not be null.

bean - must not be null.

Returns:

verify

public void verify(PersistentEntity<?,?> entity,
 Object target)

Verifies the ETag to be created for the given target bean with the current one and raises a ETagDoesntMatchException in case they don't match.

Parameters:

entity - must not be null.

target - can be null.

Throws:

ETagDoesntMatchException - in case the calculated ETag for the given bean does not match the current one.

matches

public boolean matches(PersistentEntity<?,?> entity,
 Object target)

Returns whether the ETag matches the given PersistentEntity and target. A more dissenting way of checking matches as it does not match if the ETag is NO_ETAG.

Parameters:

entity - must not be null.

target - can be null.

Returns:

addTo

public HttpHeaders addTo(HttpHeaders headers)

Adds the current ETag to the given headers.

Parameters:

headers - must not be null.

Returns:

the HttpHeaders with the ETag header been set if the current ETag instance is not NO_ETAG.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object