AMQShortString (Qpid Common 0.32 API)

java.lang.Object
- org.apache.qpid.framing.AMQShortString

All Implemented Interfaces:

CharSequence, Comparable<AMQShortString>
```
public final class AMQShortString
extends Object
implements CharSequence, Comparable<AMQShortString>
```
A short string is a representation of an AMQ Short String Short strings differ from the Java String class by being limited to on ASCII characters (0-127) and thus can be held more effectively in a byte buffer.

Field Summary

Fields
Modifier and Type Field and Description

static AMQShortString EMPTY_STRING

static int MAX_LENGTH
The maximum number of octets in AMQ short string as defined in AMQP specification

Fields
Modifier and Type	Field and Description
`static AMQShortString`	`EMPTY_STRING`
`static int`	`MAX_LENGTH` The maximum number of octets in AMQ short string as defined in AMQP specification

Constructor Summary

Constructors
Constructor and Description
`AMQShortString(byte[] data)`
`AMQShortString(byte[] data, int offset, int length)`
`AMQShortString(char[] data)`
`AMQShortString(CharSequence charSequence)`
`AMQShortString(String data)`

Method Summary

Methods
Modifier and Type	Method and Description
`char[]`	`asChars()`
`String`	`asString()`
`char`	`charAt(int index)`
`int`	`compareTo(AMQShortString name)`
`boolean`	`contains(byte b)`
`boolean`	`endsWith(AMQShortString otherString)`
`boolean`	`endsWith(String s)`
`boolean`	`equals(AMQShortString otherString)`
`boolean`	`equals(Object o)`
`boolean`	`equalsCharSequence(CharSequence s)`
`byte[]`	`getBytes()`
`int`	`hashCode()`
`AMQShortString`	`intern()`
`AMQShortString`	`intern(boolean keep)`
`static AMQShortString`	`join(Collection<AMQShortString> terms, AMQShortString delim)`
`int`	`length()` Get the length of the short string
`static AMQShortString`	`readFromBuffer(DataInput buffer)`
`void`	`setDirty()`
`AMQShortString`	`shrink()`
`boolean`	`startsWith(AMQShortString otherString)`
`boolean`	`startsWith(CharSequence otherString)`
`boolean`	`startsWith(String s)`
`CharSequence`	`subSequence(int start, int end)`
`int`	`toIntValue()`
`AMQShortStringTokenizer`	`tokenize(byte delim)`
`String`	`toString()`
`static String`	`toString(AMQShortString amqShortString)`
`static AMQShortString`	`validValueOf(Object obj)`
`static AMQShortString`	`valueOf(Object obj)`
`static AMQShortString`	`valueOf(String obj)`
`void`	`writeToBuffer(DataOutput buffer)`

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

Field Detail
- MAX_LENGTH
```
public static final int MAX_LENGTH
```
  The maximum number of octets in AMQ short string as defined in AMQP specification
  
  See Also:
  Constant Field Values
- EMPTY_STRING
```
public static final AMQShortString EMPTY_STRING
```

Constructor Detail

AMQShortString
```
public AMQShortString(byte[] data)
```

AMQShortString
```
public AMQShortString(String data)
```

AMQShortString
```
public AMQShortString(char[] data)
```

AMQShortString

public AMQShortString(CharSequence charSequence)

AMQShortString

public AMQShortString(byte[] data,
              int offset,
              int length)

Method Detail

shrink
```
public AMQShortString shrink()
```

length
```
public int length()
```
Get the length of the short string

Specified by:

length in interface CharSequence

Returns:
length of the underlying byte array

charAt
```
public char charAt(int index)
```
Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                       int end)

Specified by:: subSequence in interface CharSequence

readFromBuffer

public static AMQShortString readFromBuffer(DataInput buffer)
                                     throws IOException

Throws:: IOException

getBytes
```
public byte[] getBytes()
```

writeToBuffer

public void writeToBuffer(DataOutput buffer)
                   throws IOException

Throws:: IOException

endsWith
```
public boolean endsWith(String s)
```

endsWith

public boolean endsWith(AMQShortString otherString)

startsWith
```
public boolean startsWith(String s)
```

startsWith

public boolean startsWith(AMQShortString otherString)

startsWith

public boolean startsWith(CharSequence otherString)

asChars
```
public char[] asChars()
```

asString
```
public String asString()
```

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

equals

public boolean equals(AMQShortString otherString)

equalsCharSequence

public boolean equalsCharSequence(CharSequence s)

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

setDirty
```
public void setDirty()
```

toString
```
public String toString()
```
Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

compareTo
```
public int compareTo(AMQShortString name)
```
Specified by:

compareTo in interface Comparable<AMQShortString>

tokenize

public AMQShortStringTokenizer tokenize(byte delim)

intern
```
public AMQShortString intern()
```

intern

public AMQShortString intern(boolean keep)

join

public static AMQShortString join(Collection<AMQShortString> terms,
                  AMQShortString delim)

toIntValue
```
public int toIntValue()
```

contains
```
public boolean contains(byte b)
```

validValueOf

public static AMQShortString validValueOf(Object obj)

valueOf

public static AMQShortString valueOf(Object obj)

valueOf

public static AMQShortString valueOf(String obj)

toString

public static String toString(AMQShortString amqShortString)

Class AMQShortString

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_LENGTH

EMPTY_STRING

Constructor Detail

AMQShortString

AMQShortString

AMQShortString

AMQShortString

AMQShortString

Method Detail

shrink

length

charAt

subSequence

readFromBuffer

getBytes

writeToBuffer

endsWith

endsWith

startsWith

startsWith

startsWith

asChars

asString

equals

equals

equalsCharSequence

hashCode

setDirty

toString

compareTo

tokenize

intern

intern

join

toIntValue

contains

validValueOf

valueOf

valueOf

toString