Name.Component (jndn 0.22 API)

java.lang.Object
- net.named_data.jndn.Name.Component

All Implemented Interfaces:

Comparable

Enclosing class:

Name
```
public static class Name.Component
extends Object
implements Comparable
```
A Name.Component holds a read-only name component value.

Constructor Summary

Constructors
Constructor and Description
`Component()` Create a new GENERIC Name.Component with a zero-length value.
`Component(Blob value)` Create a new GENERIC Name.Component, using the existing the Blob value.
`Component(Blob value, ComponentType type)` Create a Name.Component of the given type, using the existing the Blob value.
`Component(Blob value, ComponentType type, int otherTypeCode)` Create a Name.Component of the given type, using the existing the Blob value.
`Component(byte[] value)` Create a new GENERIC Name.Component, copying the given value.
`Component(byte[] value, ComponentType type)` Create a Name.Component of the given type, copying the given value.
`Component(byte[] value, ComponentType type, int otherTypeCode)` Create a Name.Component of the given type, copying the given value.
`Component(Name.Component component)` Create a new Name.Component, taking another pointer to the component's read-only value.
`Component(String value)` Create a new GENERIC Name.Component, converting the value to UTF8 bytes.
`Component(String value, ComponentType type)` Create a Name.Component of the given type, converting the value to UTF8 bytes.
`Component(String value, ComponentType type, int otherTypeCode)` Create a Name.Component of the given type, converting the value to UTF8 bytes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compare(Name.Component other)` Compare this to the other Component using NDN canonical ordering.
`int`	`compareTo(Object o)`
`int`	`CompareTo(Object o)`
`boolean`	`equals(Name.Component other)` Check if this is the same component as other.
`boolean`	`equals(Object other)`
`static Name.Component`	`fromImplicitSha256Digest(Blob digest)` Create a component of type ImplicitSha256DigestComponent, so that isImplicitSha256Digest() is true.
`static Name.Component`	`fromImplicitSha256Digest(byte[] digest)` Create a component of type ImplicitSha256DigestComponent, so that isImplicitSha256Digest() is true.
`static Name.Component`	`fromNumber(long number)` Create a component whose value is the nonNegativeInteger encoding of the number.
`static Name.Component`	`fromNumber(long number, ComponentType type)` Create a component of the given type whose value is the nonNegativeInteger encoding of the number.
`static Name.Component`	`fromNumber(long number, ComponentType type, int otherTypeCode)` Create a component of the given type whose value is the nonNegativeInteger encoding of the number.
`static Name.Component`	`fromNumberWithMarker(long number, int marker)` Create a component whose value is the marker appended with the nonNegativeInteger encoding of the number.
`static Name.Component`	`fromParametersSha256Digest(Blob digest)` Create a component of type ParametersSha256DigestComponent, so that isParametersSha256Digest() is true.
`static Name.Component`	`fromParametersSha256Digest(byte[] digest)` Create a component of type ParametersSha256DigestComponent, so that isParametersSha256Digest() is true.
`static Name.Component`	`fromSegment(long segment)` Create a component with the encoded segment number according to NDN naming conventions for "Segment number" (marker 0x00).
`static Name.Component`	`fromSegmentOffset(long segmentOffset)` Create a component with the encoded segment byte offset according to NDN naming conventions for segment "Byte offset" (marker 0xFB).
`static Name.Component`	`fromSequenceNumber(long sequenceNumber)` Create a component with the encoded sequence number according to NDN naming conventions for "Sequencing" (marker 0xFE).
`static Name.Component`	`fromTimestamp(long timestamp)` Create a component with the encoded timestamp according to NDN naming conventions for "Timestamp" (marker 0xFC).
`static Name.Component`	`fromVersion(long version)` Create a component with the encoded version number according to NDN naming conventions for "Versioning" (marker 0xFD).
`int`	`getOtherTypeCode()` Get the component type code from the packet which is other than a recognized ComponentType enum value.
`Name.Component`	`getSuccessor()` Get the successor of this component, as described in Name.getSuccessor.
`ComponentType`	`getType()` Get the name component type.
`Blob`	`getValue()` Get the component value.
`int`	`hashCode()`
`boolean`	`isGeneric()` Check if this component is a generic component.
`boolean`	`isImplicitSha256Digest()` Check if this component is an ImplicitSha256Digest component.
`boolean`	`isParametersSha256Digest()` Check if this component is a ParametersSha256Digest component.
`boolean`	`isSegment()` Check if this component is a segment number according to NDN naming conventions for "Segment number" (marker 0x00).
`boolean`	`isSegmentOffset()` Check if this component is a segment byte offset according to NDN naming conventions for segment "Byte offset" (marker 0xFB).
`boolean`	`isSequenceNumber()` Check if this component is a sequence number according to NDN naming conventions for "Sequencing" (marker 0xFE).
`boolean`	`isTimestamp()` Check if this component is a timestamp according to NDN naming conventions for "Timestamp" (marker 0xFC).
`boolean`	`isVersion()` Check if this component is a version number according to NDN naming conventions for "Versioning" (marker 0xFD).
`String`	`toEscapedString()` Convert this component value by escaping characters according to the NDN URI Scheme.
`void`	`toEscapedString(StringBuffer result)` Write this component value to result, escaping characters according to the NDN URI Scheme.
`long`	`toNumber()` Interpret this name component as a network-ordered number and return an integer.
`long`	`toNumberWithMarker(int marker)` Interpret this name component as a network-ordered number with a marker and return an integer.
`long`	`toSegment()` Interpret this name component as a segment number according to NDN naming conventions for "Segment number" (marker 0x00).
`long`	`toSegmentOffset()` Interpret this name component as a segment byte offset according to NDN naming conventions for segment "Byte offset" (marker 0xFB).
`long`	`toSequenceNumber()` Interpret this name component as a sequence number according to NDN naming conventions for "Sequencing" (marker 0xFE).
`long`	`toTimestamp()` Interpret this name component as a timestamp according to NDN naming conventions for "Timestamp" (marker 0xFC).
`long`	`toVersion()` Interpret this name component as a version number according to NDN naming conventions for "Versioning" (marker 0xFD).

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Component
```
public Component()
```
    Create a new GENERIC Name.Component with a zero-length value.
  - Component
```
public Component(Blob value)
```
    Create a new GENERIC Name.Component, using the existing the Blob value. (To create an ImplicitSha256Digest component, use fromImplicitSha256Digest.) (To create a ParametersSha256Digest component, use fromParametersSha256Digest.)
    
    Parameters:
    
    value - The component value. value may not be null, but value.buf() may be null.
  - Component
```
public Component(Blob value,
                 ComponentType type)
```
    Create a Name.Component of the given type, using the existing the Blob value. (To create an ImplicitSha256Digest component, use fromImplicitSha256Digest.) (To create a ParametersSha256Digest component, use fromParametersSha256Digest.)
    
    Parameters:
    
    value - The component value. value may not be null, but value.buf() may be null.
    
    type - The component type enum value. If the name component type is not a recognized ComponentType enum value, call Name.Component(value, ComponentType.OTHER_CODE, otherTypeCode).
  - Component
```
public Component(Blob value,
                 ComponentType type,
                 int otherTypeCode)
```
    Create a Name.Component of the given type, using the existing the Blob value. (To create an ImplicitSha256Digest component, use fromImplicitSha256Digest.) (To create a ParametersSha256Digest component, use fromParametersSha256Digest.)
    
    Parameters:
    
    value - The component value. value may not be null, but value.buf() may be null.
    
    type - The component type enum value. If name component type is not a recognized ComponentType enum value, then set this to ComponentType.OTHER_CODE and use the otherTypeCode parameter.
    
    otherTypeCode - If type is ComponentType.OTHER_CODE, then this is the packet's unrecognized content type code, which must be non-negative.
  - Component
```
public Component(Name.Component component)
```
    Create a new Name.Component, taking another pointer to the component's read-only value.
    
    Parameters:
    
    component - The component to copy.
  - Component
```
public Component(byte[] value)
```
    Create a new GENERIC Name.Component, copying the given value. (To create an ImplicitSha256Digest component, use fromImplicitSha256Digest.) (To create a ParametersSha256Digest component, use fromParametersSha256Digest.)
    
    Parameters:
    
    value - The value byte array.
  - Component
```
public Component(byte[] value,
                 ComponentType type)
```
    Create a Name.Component of the given type, copying the given value. (To create an ImplicitSha256Digest component, use fromImplicitSha256Digest.) (To create a ParametersSha256Digest component, use fromParametersSha256Digest.)
    
    Parameters:
    
    value - The value byte array.
    
    type - The component type enum value. If the name component type is not a recognized ComponentType enum value, call Name.Component(value, ComponentType.OTHER_CODE, otherTypeCode).
  - Component
```
public Component(byte[] value,
                 ComponentType type,
                 int otherTypeCode)
```
    Create a Name.Component of the given type, copying the given value. (To create an ImplicitSha256Digest component, use fromImplicitSha256Digest.) (To create a ParametersSha256Digest component, use fromParametersSha256Digest.)
    
    Parameters:
    
    value - The value byte array.
    
    type - The component type enum value. If name component type is not a recognized ComponentType enum value, then set this to ComponentType.OTHER_CODE and use the otherTypeCode parameter.
    
    otherTypeCode - If type is ComponentType.OTHER_CODE, then this is the packet's unrecognized content type code, which must be non-negative.
  - Component
```
public Component(String value)
```
    Create a new GENERIC Name.Component, converting the value to UTF8 bytes. Note, this does not escape %XX values. If you need to escape, use Name.fromEscapedString.
    
    Parameters:
    
    value - The string to convert to UTF8.
  - Component
```
public Component(String value,
                 ComponentType type)
```
    Create a Name.Component of the given type, converting the value to UTF8 bytes.
    
    Parameters:
    
    value - The string to convert to UTF8.
    
    type - The component type enum value. If the name component type is not a recognized ComponentType enum value, call Name.Component(value, ComponentType.OTHER_CODE, otherTypeCode).
  - Component
```
public Component(String value,
                 ComponentType type,
                 int otherTypeCode)
```
    Create a Name.Component of the given type, converting the value to UTF8 bytes.
    
    Parameters:
    
    value - The string to convert to UTF8.
    
    type - The component type enum value. If name component type is not a recognized ComponentType enum value, then set this to ComponentType.OTHER_CODE and use the otherTypeCode parameter.
    
    otherTypeCode - If type is ComponentType.OTHER_CODE, then this is the packet's unrecognized content type code, which must be non-negative.
- Method Detail
  - getValue
```
public final Blob getValue()
```
    Get the component value.
    
    Returns:
    
    The component value.
  - getType
```
public final ComponentType getType()
```
    Get the name component type.
    
    Returns:
    
    The name component type enum value. If this is ComponentType.OTHER_CODE, then call getOtherTypeCode() to get the unrecognized component type code.
  - getOtherTypeCode
```
public final int getOtherTypeCode()
```
    Get the component type code from the packet which is other than a recognized ComponentType enum value. This is only meaningful if getType() is ComponentType.OTHER_CODE.
    
    Returns:
    
    The type code.
  - toEscapedString
```
public final void toEscapedString(StringBuffer result)
```
    Write this component value to result, escaping characters according to the NDN URI Scheme. This also adds "..." to a value with zero or more ".". This adds a type code prefix as needed, such as "sha256digest=".
    
    Parameters:
    
    result - The StringBuffer to write to.
  - toEscapedString
```
public final String toEscapedString()
```
    Convert this component value by escaping characters according to the NDN URI Scheme. This also adds "..." to a value with zero or more ".". This adds a type code prefix as needed, such as "sha256digest=".
    
    Returns:
    
    The escaped string.
  - isSegment
```
public final boolean isSegment()
```
    Check if this component is a segment number according to NDN naming conventions for "Segment number" (marker 0x00). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Returns:
    
    True if this is a segment number.
  - isSegmentOffset
```
public final boolean isSegmentOffset()
```
    Check if this component is a segment byte offset according to NDN naming conventions for segment "Byte offset" (marker 0xFB). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Returns:
    
    True if this is a segment byte offset.
  - isVersion
```
public final boolean isVersion()
```
    Check if this component is a version number according to NDN naming conventions for "Versioning" (marker 0xFD).
    
    Returns:
    
    True if this is a version number.
  - isTimestamp
```
public final boolean isTimestamp()
```
    Check if this component is a timestamp according to NDN naming conventions for "Timestamp" (marker 0xFC). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Returns:
    
    True if this is a timestamp.
  - isSequenceNumber
```
public final boolean isSequenceNumber()
```
    Check if this component is a sequence number according to NDN naming conventions for "Sequencing" (marker 0xFE). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Returns:
    
    True if this is a sequence number.
  - isGeneric
```
public final boolean isGeneric()
```
    Check if this component is a generic component.
    
    Returns:
    
    True if this is an generic component.
  - isImplicitSha256Digest
```
public final boolean isImplicitSha256Digest()
```
    Check if this component is an ImplicitSha256Digest component.
    
    Returns:
    
    True if this is an ImplicitSha256Digest component.
  - isParametersSha256Digest
```
public final boolean isParametersSha256Digest()
```
    Check if this component is a ParametersSha256Digest component.
    
    Returns:
    
    True if this is a ParametersSha256Digest component.
  - toNumber
```
public final long toNumber()
```
    Interpret this name component as a network-ordered number and return an integer.
    
    Returns:
    
    The integer number.
  - toNumberWithMarker
```
public final long toNumberWithMarker(int marker)
                              throws EncodingException
```
    Interpret this name component as a network-ordered number with a marker and return an integer.
    
    Parameters:
    
    marker - The required first byte of the component.
    
    Returns:
    
    The integer number.
    
    Throws:
    
    EncodingException - If the first byte of the component does not equal the marker.
  - toSegment
```
public final long toSegment()
                     throws EncodingException
```
    Interpret this name component as a segment number according to NDN naming conventions for "Segment number" (marker 0x00). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Returns:
    
    The integer segment number.
    
    Throws:
    
    EncodingException - If the first byte of the component is not the expected marker.
  - toSegmentOffset
```
public final long toSegmentOffset()
                           throws EncodingException
```
    Interpret this name component as a segment byte offset according to NDN naming conventions for segment "Byte offset" (marker 0xFB). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Returns:
    
    The integer segment byte offset.
    
    Throws:
    
    EncodingException - If the first byte of the component is not the expected marker.
  - toVersion
```
public final long toVersion()
                     throws EncodingException
```
    Interpret this name component as a version number according to NDN naming conventions for "Versioning" (marker 0xFD). Note that this returns the exact number from the component without converting it to a time representation.
    
    Returns:
    
    The integer version number.
    
    Throws:
    
    EncodingException - If the first byte of the component is not the expected marker.
  - toTimestamp
```
public final long toTimestamp()
                       throws EncodingException
```
    Interpret this name component as a timestamp according to NDN naming conventions for "Timestamp" (marker 0xFC). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Returns:
    
    The number of microseconds since the UNIX epoch (Thursday, 1 January 1970) not counting leap seconds.
    
    Throws:
    
    EncodingException - If the first byte of the component is not the expected marker.
  - toSequenceNumber
```
public final long toSequenceNumber()
                            throws EncodingException
```
    Interpret this name component as a sequence number according to NDN naming conventions for "Sequencing" (marker 0xFE). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Returns:
    
    The integer sequence number.
    
    Throws:
    
    EncodingException - If the first byte of the component is not the expected marker.
  - fromNumber
```
public static Name.Component fromNumber(long number)
```
    Create a component whose value is the nonNegativeInteger encoding of the number.
    
    Parameters:
    
    number - The number to be encoded.
    
    Returns:
    
    The component value.
  - fromNumber
```
public static Name.Component fromNumber(long number,
                                        ComponentType type)
```
    Create a component of the given type whose value is the nonNegativeInteger encoding of the number.
    
    Parameters:
    
    number - The number to be encoded.
    
    type - The component type enum value. If the name component type is not a recognized ComponentType enum value, call fromNumber(number, ComponentType.OTHER_CODE, otherTypeCode).
    
    Returns:
    
    The component value.
  - fromNumber
```
public static Name.Component fromNumber(long number,
                                        ComponentType type,
                                        int otherTypeCode)
```
    Create a component of the given type whose value is the nonNegativeInteger encoding of the number.
    
    Parameters:
    
    number - The number to be encoded.
    
    type - The component type enum value. If name component type is not a recognized ComponentType enum value, then set this to ComponentType.OTHER_CODE and use the otherTypeCode parameter.
    
    otherTypeCode - If type is ComponentType.OTHER_CODE, then this is the packet's unrecognized content type code, which must be non-negative.
    
    Returns:
    
    The component value.
  - fromNumberWithMarker
```
public static Name.Component fromNumberWithMarker(long number,
                                                  int marker)
```
    Create a component whose value is the marker appended with the nonNegativeInteger encoding of the number.
    
    Parameters:
    
    number - The number to be encoded.
    
    marker - The marker to use as the first byte of the component.
    
    Returns:
    
    The component value.
  - fromSegment
```
public static Name.Component fromSegment(long segment)
```
    Create a component with the encoded segment number according to NDN naming conventions for "Segment number" (marker 0x00). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Parameters:
    
    segment - The segment number.
    
    Returns:
    
    The new Component.
  - fromSegmentOffset
```
public static Name.Component fromSegmentOffset(long segmentOffset)
```
    Create a component with the encoded segment byte offset according to NDN naming conventions for segment "Byte offset" (marker 0xFB). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Parameters:
    
    segmentOffset - The segment byte offset.
    
    Returns:
    
    The new Component.
  - fromVersion
```
public static Name.Component fromVersion(long version)
```
    Create a component with the encoded version number according to NDN naming conventions for "Versioning" (marker 0xFD). http://named-data.net/doc/tech-memos/naming-conventions.pdf Note that this encodes the exact value of version without converting from a time representation.
    
    Parameters:
    
    version - The version number.
    
    Returns:
    
    The new Component.
  - fromTimestamp
```
public static Name.Component fromTimestamp(long timestamp)
```
    Create a component with the encoded timestamp according to NDN naming conventions for "Timestamp" (marker 0xFC). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Parameters:
    
    timestamp - The number of microseconds since the UNIX epoch (Thursday, 1 January 1970) not counting leap seconds.
    
    Returns:
    
    The new Component.
  - fromSequenceNumber
```
public static Name.Component fromSequenceNumber(long sequenceNumber)
```
    Create a component with the encoded sequence number according to NDN naming conventions for "Sequencing" (marker 0xFE). http://named-data.net/doc/tech-memos/naming-conventions.pdf
    
    Parameters:
    
    sequenceNumber - The sequence number.
    
    Returns:
    
    The new Component.
  - fromImplicitSha256Digest
```
public static Name.Component fromImplicitSha256Digest(Blob digest)
                                               throws EncodingException
```
    Create a component of type ImplicitSha256DigestComponent, so that isImplicitSha256Digest() is true.
    
    Parameters:
    
    digest - The SHA-256 digest value.
    
    Returns:
    
    The new Component.
    
    Throws:
    
    EncodingException - If the digest length is not 32 bytes.
  - fromImplicitSha256Digest
```
public static Name.Component fromImplicitSha256Digest(byte[] digest)
                                               throws EncodingException
```
    Create a component of type ImplicitSha256DigestComponent, so that isImplicitSha256Digest() is true.
    
    Parameters:
    
    digest - The SHA-256 digest value.
    
    Returns:
    
    The new Component.
    
    Throws:
    
    EncodingException - If the digest length is not 32 bytes.
  - fromParametersSha256Digest
```
public static Name.Component fromParametersSha256Digest(Blob digest)
                                                 throws EncodingException
```
    Create a component of type ParametersSha256DigestComponent, so that isParametersSha256Digest() is true.
    
    Parameters:
    
    digest - The SHA-256 digest value.
    
    Returns:
    
    The new Component.
    
    Throws:
    
    EncodingException - If the digest length is not 32 bytes.
  - fromParametersSha256Digest
```
public static Name.Component fromParametersSha256Digest(byte[] digest)
                                                 throws EncodingException
```
    Create a component of type ParametersSha256DigestComponent, so that isParametersSha256Digest() is true.
    
    Parameters:
    
    digest - The SHA-256 digest value.
    
    Returns:
    
    The new Component.
    
    Throws:
    
    EncodingException - If the digest length is not 32 bytes.
  - getSuccessor
```
public final Name.Component getSuccessor()
```
    Get the successor of this component, as described in Name.getSuccessor.
    
    Returns:
    
    A new Name.Component which is the successor of this.
  - equals
```
public final boolean equals(Name.Component other)
```
    Check if this is the same component as other.
    
    Parameters:
    
    other - The other Component to compare with.
    
    Returns:
    
    True if the components are equal, otherwise false.
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compare
```
public final int compare(Name.Component other)
```
    Compare this to the other Component using NDN canonical ordering.
    
    Parameters:
    
    other - The other Component to compare with.
    
    Returns:
    
    0 If they compare equal, -1 if this comes before other in the canonical ordering, or 1 if this comes after other in the canonical ordering.
  - compareTo
```
public final int compareTo(Object o)
```
    Specified by:
    
    compareTo in interface Comparable
  - CompareTo
```
public final int CompareTo(Object o)
```

Class Name.Component

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Component

Component

Component

Component

Component

Component

Component

Component

Component

Component

Component

Method Detail

getValue

getType

getOtherTypeCode

toEscapedString

toEscapedString

isSegment

isSegmentOffset

isVersion

isTimestamp

isSequenceNumber

isGeneric

isImplicitSha256Digest

isParametersSha256Digest

toNumber

toNumberWithMarker

toSegment

toSegmentOffset

toVersion

toTimestamp

toSequenceNumber

fromNumber

fromNumber

fromNumber

fromNumberWithMarker

fromSegment

fromSegmentOffset

fromVersion

fromTimestamp

fromSequenceNumber

fromImplicitSha256Digest

fromImplicitSha256Digest

fromParametersSha256Digest

fromParametersSha256Digest

getSuccessor

equals

equals

hashCode

compare

compareTo

CompareTo