Top Description Inners Fields Constructors Methods
com.sun.jna

pack-priv Class NativeString

extends Object
implements CharSequence, Comparable
Class Inheritance
All Implemented Interfaces
java.lang.Comparable, java.lang.CharSequence

Provides a temporary allocation of an immutable C string (const char* or const wchar_t*) for use when converting a Java String into a native memory function argument.
Authors
Todd Fast, [email protected], [email protected]

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class

Field Summary

Modifier and TypeField and Description
private String
private Pointer
pack-priv static final String

Constructor Summary

AccessConstructor and Description
public
NativeString(String string)

Create a native string (NUL-terminated array of char).

public
NativeString(String
value to write to native memory
string
,
boolean
whether to store the String as wchar_t
wide
)

Create a native string as a NUL-terminated array of wchar_t (if wide is true) or char.

public
NativeString(WString string)

Create a native string as a NUL-terminated array of wchar_t.

public
NativeString(String string, String encoding)

Create a native string (NUL-terminated array of char), using the requested encoding.

Method Summary

Modifier and TypeMethod and Description
public char
charAt(int
the index of the char value to be returned
index
)

Implements java.lang.CharSequence.charAt.

Returns the char value at the specified index.
public int
compareTo(Object
the object to be compared.
other
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public Pointer
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public int
length()

Implements java.lang.CharSequence.length.

Returns the length of this character sequence.
public CharSequence
subSequence(int
the start index, inclusive
start
,
int
the end index, exclusive
end
)

Implements java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence.
public String
toString()

Overrides java.lang.Object.toString.

Implements java.lang.CharSequence.toString.

Returns a string containing the characters in this sequence in the same order as this sequence.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

encodingback to summary
private String encoding
pointerback to summary
private Pointer pointer
WIDE_STRINGback to summary
pack-priv static final String WIDE_STRING

Constructor Detail

NativeStringback to summary
public NativeString(String string)

Create a native string (NUL-terminated array of char).

Uses the encoding returned by Native#getDefaultStringEncoding().

NativeStringback to summary
public NativeString(String string, boolean wide)

Create a native string as a NUL-terminated array of wchar_t (if wide is true) or char.

If not wide, the encoding is obtained from Native#getDefaultStringEncoding().

Parameters
string:String

value to write to native memory

wide:boolean

whether to store the String as wchar_t

NativeStringback to summary
public NativeString(WString string)

Create a native string as a NUL-terminated array of wchar_t.

NativeStringback to summary
public NativeString(String string, String encoding)

Create a native string (NUL-terminated array of char), using the requested encoding.

Method Detail

charAtback to summary
public char charAt(int index)

Implements java.lang.CharSequence.charAt.

Doc from java.lang.CharSequence.charAt.

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters
index:int

the index of the char value to be returned

Returns:char

the specified char value

Annotations
@Override
compareToback to summary
public int compareTo(Object other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:Object

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getPointerback to summary
public Pointer getPointer()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
lengthback to summary
public int length()

Implements java.lang.CharSequence.length.

Doc from java.lang.CharSequence.length.

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Returns:int

the number of chars in this sequence

Annotations
@Override
subSequenceback to summary
public CharSequence subSequence(int start, int end)

Implements java.lang.CharSequence.subSequence.

Doc from java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters
start:int

the start index, inclusive

end:int

the end index, exclusive

Returns:CharSequence

the specified subsequence

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Implements java.lang.CharSequence.toString.

Doc from java.lang.CharSequence.toString.

Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.

Returns:String

a string consisting of exactly this sequence of characters

Annotations
@Override
com.sun.jna back to summary

private Class NativeString.StringMemory

extends Memory
Class Inheritance

Field Summary

Inherited from com.sun.jna.Memory:
size

Constructor Summary

AccessConstructor and Description
public
StringMemory(long size)

Method Summary

Modifier and TypeMethod and Description
public String
toString()

Overrides com.sun.jna.Memory.toString.

Returns a string representation of the object.
Inherited from com.sun.jna.Memory:
alignboundsCheckclearclosedisposedisposeAlldumpfreegetBytegetByteBuffergetChargetDoublegetFloatgetIntgetLonggetPointergetShortgetStringgetWideStringmallocpurgereadreadreadreadreadreadreadreadsetBytesetCharsetDoublesetFloatsetIntsetLongsetPointersetShortsetStringsetWideStringsharesharesizevalidwritewritewritewritewritewritewritewrite

Constructor Detail

StringMemoryback to summary
public StringMemory(long size)

Method Detail

toStringback to summary
public String toString()

Overrides com.sun.jna.Memory.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override