Package com.io7m.smfj.core

Class SMFMetadataValue

java.lang.Object

com.io7m.smfj.core.SMFMetadataValue

All Implemented Interfaces:

SMFMetadataValueType

public final class SMFMetadataValue
extends java.lang.Object
implements SMFMetadataValueType

A parsed metadata value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SMFMetadataValue.Builder	Builds instances of type SMFMetadataValue.

Method Summary

Modifier and Type	Method	Description
static SMFMetadataValue.Builder	builder()	Creates a builder for SMFMetadataValue.
static SMFMetadataValue	copyOf(SMFMetadataValueType instance)	Creates an immutable copy of a SMFMetadataValueType value.
byte[]	data()
boolean	equals(java.lang.Object another)	This instance is equal to all instances of SMFMetadataValue that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: schemaId, data.
static SMFMetadataValue	of(SMFSchemaIdentifier schemaId, byte[] data)	Construct a new immutable SMFMetadataValue instance.
SMFSchemaIdentifier	schemaId()
java.lang.String	toString()	Prints the immutable value SMFMetadataValue with attribute values.
SMFMetadataValue	withData(byte... elements)	Copy the current immutable object with elements that replace the content of data.
SMFMetadataValue	withSchemaId(SMFSchemaIdentifier value)	Copy the current immutable object by setting a value for the schemaId attribute.

Methods inherited from class java.lang.Object

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

Method Detail

schemaId

public SMFSchemaIdentifier schemaId()

Specified by:

schemaId in interface SMFMetadataValueType

Returns:

The metadata schema

data

public byte[] data()

Specified by:

data in interface SMFMetadataValueType

Returns:

The raw metadata bytes

withSchemaId

public final SMFMetadataValue withSchemaId(SMFSchemaIdentifier value)

Copy the current immutable object by setting a value for the schemaId attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for schemaId

Returns:

A modified copy of the this object

withData

public final SMFMetadataValue withData(byte... elements)

Copy the current immutable object with elements that replace the content of data. The array is cloned before being saved as attribute values.

Parameters:

elements - The non-null elements for data

Returns:

A modified copy of this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of SMFMetadataValue that have equal attribute values.

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: schemaId, data.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value SMFMetadataValue with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static SMFMetadataValue of(SMFSchemaIdentifier schemaId,
                                  byte[] data)

Construct a new immutable SMFMetadataValue instance.

Parameters:

schemaId - The value for the schemaId attribute

data - The value for the data attribute

Returns:

An immutable SMFMetadataValue instance

copyOf

public static SMFMetadataValue copyOf(SMFMetadataValueType instance)

Creates an immutable copy of a SMFMetadataValueType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable SMFMetadataValue instance

builder

public static SMFMetadataValue.Builder builder()

Creates a builder for SMFMetadataValue.

 SMFMetadataValue.builder()
    .setSchemaId(com.io7m.smfj.core.SMFSchemaIdentifier) // required schemaId
    .setData(byte) // required data
    .build();
 

Returns:

A new SMFMetadataValue builder