org.springframework.data.history

Interface RevisionMetadata<N extends Number & Comparable<N>>

All Known Implementing Classes:

AnnotationRevisionMetadata

public interface RevisionMetadata<N extends Number & Comparable<N>>

Metadata about a revision.

Author:

Philipp Huegelmeyer, Oliver Gierke

Method Summary

Modifier and Type	Method and Description
<T> T	getDelegate() Returns the underlying revision metadata which might provider more detailed implementation specific information.
default LocalDateTime	getRequiredRevisionDate() Returns the revision date of the revision, immediately failing on absence.
default N	getRequiredRevisionNumber() Returns the revision number of the revision, immediately failing on absence.
Optional<LocalDateTime>	getRevisionDate() Returns the date of the revision.
Optional<N>	getRevisionNumber() Returns the revision number of the revision.

Method Detail

getRevisionNumber

Optional<N> getRevisionNumber()

Returns the revision number of the revision.

Returns:

will never be null.

getRequiredRevisionNumber

default N getRequiredRevisionNumber()

Returns the revision number of the revision, immediately failing on absence.

Returns:

will never be null.

Throws:

IllegalStateException - if no revision number is available.

getRevisionDate

Optional<LocalDateTime> getRevisionDate()

Returns the date of the revision.

Returns:

will never be null.

getRequiredRevisionDate

default LocalDateTime getRequiredRevisionDate()

Returns the revision date of the revision, immediately failing on absence.

Returns:

will never be null.

getDelegate

<T> T getDelegate()

Returns the underlying revision metadata which might provider more detailed implementation specific information.

Returns: