Name.Component (jndn 0.6 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
`Name.Component()` Create a new Name.Component with a zero-length value.
`Name.Component(Blob value)` Create a new Name.Component, using the existing the Blob value.
`Name.Component(byte[] value)` Create a new Name.Component, copying the given value.
`Name.Component(Name.Component component)` Create a new Name.Component, taking another pointer to the component's read-only value.
`Name.Component(String value)` Create a new Name.Component, converting the value to UTF8 bytes.

Method Summary

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)`
`boolean`	`equals(Name.Component other)` Check if this is the same component as other.
`boolean`	`equals(Object other)`
`static Name.Component`	`fromNumber(long number)` Create a component 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.
`Blob`	`getValue()` Get the component value.
`int`	`hashCode()`
`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
  - Name.Component
```
public Name.Component()
```
    Create a new Name.Component with a zero-length value.
  - Name.Component
```
public Name.Component(Blob value)
```
    Create a new Name.Component, using the existing the Blob value.
    
    Parameters:
    value - The component value. value may not be null, but value.buf() may be null.
  - Name.Component
```
public Name.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.
  - Name.Component
```
public Name.Component(byte[] value)
```
    Create a new Name.Component, copying the given value.
    
    Parameters:
    value - The value byte array.
  - Name.Component
```
public Name.Component(String value)
```
    Create a new 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.
- Method Detail
  - getValue
```
public final Blob getValue()
```
    Get the component value.
    
    Returns:
    The component value.
  - 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 ".".
    
    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 ".".
    
    Returns:
    The escaped string.
  - 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.
  - 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.
  - 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

Class Name.Component

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Name.Component

Name.Component

Name.Component

Name.Component

Name.Component

Method Detail

getValue

toEscapedString

toEscapedString

toNumber

toNumberWithMarker

toSegment

toSegmentOffset

toVersion

toTimestamp

toSequenceNumber

fromNumber

fromNumberWithMarker

equals

equals

hashCode

compare

compareTo