org.radix.serialization2

Annotation Type DsonOutput

@Documented
 @Target(value={FIELD,METHOD})
 @Retention(value=RUNTIME)
public @interface DsonOutput

Annotation used to indicate which fields are included in coded DSON for which output requirements. As an example, the "serializer" field and any signature fields, are not included in "HASH" output, as they are not included in any hash computation.

As an example, to include a field only in data persisted to disk, the following annotation might be used:

         @DsonOutput(Output.PERSIST)
         @JsonProperty("diskTimestamp")
         private long diskTimestamp;
 

To exclude data from being included in a hash, the following annotation could be used:

         @DsonOutput(value = Output.HASH, include = false)
         @JsonProperty("signature")
         private byte[] signature;
 

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
DsonOutput.Output[]	value The serialization output modes for which this field should be included or excluded, depending on the value of include().

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	include true if value() specified output modes where this field is to be included.

Element Detail

value

public abstract DsonOutput.Output[] value

The serialization output modes for which this field should be included or excluded, depending on the value of include().

Returns:

The output modes for which this field should be included or excluded.

See Also:

include()

include

public abstract boolean include

true if value() specified output modes where this field is to be included. Otherwise value() specifies modes where this field is to be excluded.

Returns:

true if field to be included for specified modes, false otherwise.

Default:

true