craterdog.security

Class DocumentAttributes

java.lang.Object

craterdog.smart.SmartObject<DocumentAttributes>

craterdog.security.DocumentAttributes

All Implemented Interfaces:

craterdog.core.Composite, Comparable<DocumentAttributes>

public class DocumentAttributes
extends craterdog.smart.SmartObject<DocumentAttributes>

This class defines the attributes that make up a document that can be notarized.

Author:

Derk Norton

Field Summary

Fields

Modifier and Type	Field and Description
Watermark	watermark A watermark describing how the document is signed and when it expires.

Constructor Summary

Constructors

Constructor and Description
DocumentAttributes() The default constructor ensures that the custom attribute types (like tags) will be formatted correctly when printed.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	any() This method returns a map of the attributes that are not explicitly defined.
Object	get(String name) This method returns the value of the attribute associated with the specified name, or null if none exists.
Object	put(String name, Object value) This method allows the setting of attributes that are not explicitly defined.

Methods inherited from class craterdog.smart.SmartObject

addSerializableClass, addSerializableClass, compareTo, copy, equals, hashCode, toExposedString, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

watermark

public Watermark watermark

A watermark describing how the document is signed and when it expires.

Constructor Detail

DocumentAttributes

public DocumentAttributes()

The default constructor ensures that the custom attribute types (like tags) will be formatted correctly when printed.

Method Detail

get

public Object get(String name)

This method returns the value of the attribute associated with the specified name, or null if none exists.

Parameters:

name - The name of the attribute to be returned.

Returns:

The value of the attribute.

put

public Object put(String name,
                  Object value)

This method allows the setting of attributes that are not explicitly defined.

Parameters:

name - The name of the attribute.

value - The value to be associated with this attribute name.

Returns:

Any previous attribute value associated with this attribute name.

any

public Map<String,Object> any()

This method returns a map of the attributes that are not explicitly defined. It is primarily used by the Jackson parser during deserialization of the corresponding JSON.

Returns:

A map containing the attributes.