Package org.opendaylight.yangtools.yang.common

Interface RevisionUnion

All Superinterfaces:

Comparable<RevisionUnion>, Immutable, Serializable, WritableObject

All Known Implementing Classes:

NotRevision, Revision

@NonNullByDefault
public sealed interface RevisionUnion
extends Comparable<RevisionUnion>, Immutable, Serializable, WritableObject
permits Revision, NotRevision

A capture of an optional revision-date. This is a replacement for Optional<Revision>, with the added benefit of having a non-null string representation in unionString(), which is also conveniently returned from toString().

This contract is exactly the same as this fragment from ietf-yang-library:

   type union {
     type revision-identifier;
     type string {
       length "0";
     }
   }
 

Method Summary

Modifier and Type	Method	Description
default int	compareTo(RevisionUnion o)
boolean	equals(@Nullable Object obj)
default Optional<Revision>	findRevision()
default Revision	getRevision()
int	hashCode()
static NotRevision	none()	Return empty RevisionUnion.
static RevisionUnion	of(String unionString)
static RevisionUnion	of(@Nullable Revision revision)
static RevisionUnion	readFrom(DataInput in)
@Nullable Revision	revision()	Return the Revision, if present.
String	toString()	Returns unionString().
String	unionString()	A revision-date-compliant date, or an empty string ("").
default void	writeTo(DataOutput out)	Serialize this object into a DataOutput as a fixed-format stream.

Method Details

none

static NotRevision none()

Return empty RevisionUnion.

Returns:

empty RevisionUnion

of

static RevisionUnion of(String unionString)

of

static RevisionUnion of(@Nullable Revision revision)

unionString

String unionString()

A revision-date-compliant date, or an empty string ("").

Returns:

A revision-date or empty string

revision

@Nullable Revision revision()

Return the Revision, if present.

Returns:

the revision, or null if not present

findRevision

default Optional<Revision> findRevision()

getRevision

default Revision getRevision()

compareTo

default int compareTo(RevisionUnion o)

Specified by:

compareTo in interface Comparable<RevisionUnion>

writeTo

default void writeTo(DataOutput out)
              throws IOException

Description copied from interface: WritableObject

Serialize this object into a DataOutput as a fixed-format stream.

Specified by:

writeTo in interface WritableObject

Parameters:

out - Data output

Throws:

IOException - if an I/O error occurs

readFrom

static RevisionUnion readFrom(DataInput in)
                       throws IOException

Throws:

IOException

hashCode

int hashCode()

Overrides:

hashCode in class Object

equals

boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

toString

String toString()

Returns unionString().

Overrides:

toString in class Object

Returns:

unionString()