org.atlasapi.entity.util

Class WriteResult<W>

java.lang.Object

org.atlasapi.entity.util.WriteResult<W>

Type Parameters:

W - - type of the written resource

All Implemented Interfaces:

Comparable<WriteResult<?>>

public final class WriteResult<W>
extends Object
implements Comparable<WriteResult<?>>

Represents the result of a call to a write/store procedure, for use with *Store types. Immutable given W is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriteResult.Builder<W>

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Predicate<WriteResult<?>>	WRITTEN

Constructor Summary

Constructors

Constructor and Description
WriteResult(W resource, boolean written, org.joda.time.DateTime writeTime, W previous)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(WriteResult<?> other)
boolean	equals(Object that)
com.google.common.base.Optional<W>	getPrevious() The previous version of the resource.
W	getResource() The resource as it was written when the write was attempted.
org.joda.time.DateTime	getWriteTime() The time at which the write was attempted.
int	hashCode()
static <W> WriteResult.Builder<W>	result(W resource, boolean wasWritten)
String	toString()
static <W> WriteResult.Builder<W>	unwritten(W resource)
boolean	written() Indicates whether the resource was actually written at this call to write.
static <W> WriteResult.Builder<W>	written(W resource)
static <W> com.google.common.base.Predicate<WriteResult<? extends W>>	writtenFilter()

Methods inherited from class java.lang.Object

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

Field Detail

WRITTEN

public static final com.google.common.base.Predicate<WriteResult<?>> WRITTEN

Constructor Detail

WriteResult

public WriteResult(W resource,
           boolean written,
           org.joda.time.DateTime writeTime,
           @Nullable
           W previous)

Method Detail

writtenFilter

public static final <W> com.google.common.base.Predicate<WriteResult<? extends W>> writtenFilter()

result

public static final <W> WriteResult.Builder<W> result(W resource,
                                boolean wasWritten)

unwritten

public static final <W> WriteResult.Builder<W> unwritten(W resource)

written

public static final <W> WriteResult.Builder<W> written(W resource)

getResource

public W getResource()

The resource as it was written when the write was attempted.

Returns:

- the resource

written

public boolean written()

Indicates whether the resource was actually written at this call to write.

Returns:

true iff the resource was written.

getWriteTime

public org.joda.time.DateTime getWriteTime()

The time at which the write was attempted.

Returns:

getPrevious

public com.google.common.base.Optional<W> getPrevious()

The previous version of the resource.

Returns:

compareTo

public int compareTo(WriteResult<?> other)

Specified by:

compareTo in interface Comparable<WriteResult<?>>

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object