net.named_data.jndn

Class Data

java.lang.Object

net.named_data.jndn.Data

All Implemented Interfaces:

SignatureHolder, ChangeCountable

Direct Known Subclasses:

Certificate

public class Data
extends Object
implements ChangeCountable, SignatureHolder

Constructor Summary

Constructors

Constructor and Description
Data() Create a new Data object with default values and where the signature is a blank Sha256WithRsaSignature.
Data(Data data) Create a deep copy of the given data object, including a clone of the signature object.
Data(Name name) Create a new Data object with the given name and default values and where the signature is a blank Sha256WithRsaSignature.

Method Summary

Methods

Modifier and Type	Method and Description
long	getChangeCount() Get the change count, which is incremented each time this object (or a child object) is changed.
Blob	getContent()
SignedBlob	getDefaultWireEncoding() Return a pointer to the defaultWireEncoding, which was encoded with getDefaultWireEncodingFormat().
long	getIncomingFaceId() Get the incoming face ID of the local control header.
MetaInfo	getMetaInfo()
Name	getName()
Signature	getSignature()
Data	setContent(Blob content)
Data	setMetaInfo(MetaInfo metaInfo) Set metaInfo to a copy of the given MetaInfo.
Data	setName(Name name) Set name to a copy of the given Name.
Data	setSignature(Signature signature) Set the signature to a copy of the given signature.
void	wireDecode(Blob input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this Data.
void	wireDecode(Blob input, WireFormat wireFormat) Decode the input using a particular wire format and update this Data.
void	wireDecode(ByteBuffer input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this Data.
void	wireDecode(ByteBuffer input, WireFormat wireFormat) Decode the input using a particular wire format and update this Data.
SignedBlob	wireEncode() Encode this Data for the default wire format WireFormat.getDefaultWireFormat().
SignedBlob	wireEncode(WireFormat wireFormat) Encode this Data for a particular wire format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Data

public Data()

Create a new Data object with default values and where the signature is a blank Sha256WithRsaSignature.

Data

public Data(Name name)

Create a new Data object with the given name and default values and where the signature is a blank Sha256WithRsaSignature.

Parameters:

name - The name which is copied.

Data

public Data(Data data)

Create a deep copy of the given data object, including a clone of the signature object.

Parameters:

data - The data object to copy.

Method Detail

wireEncode

public final SignedBlob wireEncode(WireFormat wireFormat)

Encode this Data for a particular wire format. If wireFormat is the default wire format, also set the defaultWireEncoding field to the encoded result.

Parameters:

wireFormat - A WireFormat object used to decode the input.

Returns:

The encoded buffer.

wireEncode

public final SignedBlob wireEncode()

Encode this Data for the default wire format WireFormat.getDefaultWireFormat(). Also set the defaultWireEncoding field to the encoded result.

Returns:

The encoded buffer.

wireDecode

public void wireDecode(Blob input,
              WireFormat wireFormat)
                throws EncodingException

Decode the input using a particular wire format and update this Data. If wireFormat is the default wire format, also set the defaultWireEncoding field another pointer to the input Blob.

Parameters:

input - The input Blob to decode. This reads from buf().position() to buf().limit(), but does not change the position.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input)
                      throws EncodingException

Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this Data. Also set the defaultWireEncoding field another pointer to the input Blob.

Parameters:

input - The input Blob to decode. This reads from buf().position() to buf().limit(), but does not change the position.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(ByteBuffer input,
              WireFormat wireFormat)
                      throws EncodingException

Decode the input using a particular wire format and update this Data. If wireFormat is the default wire format, also set the defaultWireEncoding field to a copy of the input. (To not copy the input, see wireDecode(Blob).)

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(ByteBuffer input)
                      throws EncodingException

Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this Data. Also set the defaultWireEncoding field to the input.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

Throws:

EncodingException - For invalid encoding.

getSignature

public final Signature getSignature()

Specified by:

getSignature in interface SignatureHolder

getName

public final Name getName()

getMetaInfo

public final MetaInfo getMetaInfo()

getContent

public final Blob getContent()

getIncomingFaceId

public final long getIncomingFaceId()

Get the incoming face ID of the local control header.

Returns:

The incoming face ID. If not specified, return -1.

Note:

This is an experimental feature. This API may change in the future.

getDefaultWireEncoding

public final SignedBlob getDefaultWireEncoding()

Return a pointer to the defaultWireEncoding, which was encoded with getDefaultWireEncodingFormat().

Returns:

The default wire encoding. Its pointer may be null.

setSignature

public final Data setSignature(Signature signature)

Set the signature to a copy of the given signature.

Specified by:

setSignature in interface SignatureHolder

Parameters:

signature - The signature object which is cloned.

Returns:

This Data so that you can chain calls to update values.

setName

public Data setName(Name name)

Set name to a copy of the given Name. This is not final so that a subclass can override to validate the name.

Parameters:

name - The Name which is copied.

Returns:

This Data so that you can chain calls to update values.

setMetaInfo

public final Data setMetaInfo(MetaInfo metaInfo)

Set metaInfo to a copy of the given MetaInfo.

Parameters:

metaInfo - The MetaInfo which is copied.

Returns:

This Data so that you can chain calls to update values.

setContent

public final Data setContent(Blob content)

getChangeCount

public final long getChangeCount()

Get the change count, which is incremented each time this object (or a child object) is changed.

Specified by:

getChangeCount in interface ChangeCountable

Returns:

The change count.