com.jniwrapper
Class ExternalStringPointer

java.lang.Object
  extended bycom.jniwrapper.Parameter
      extended bycom.jniwrapper.Pointer.Void
          extended bycom.jniwrapper.ExternalStringPointer
All Implemented Interfaces:
IntegerParameter, PointerParameter

public class ExternalStringPointer
extends Pointer.Void

This class is specially designed to read a string, which is created externally and its length is unknown beforehand.


Field Summary
 
Fields inherited from class com.jniwrapper.Parameter
LICENSE_TYPE, V
 
Constructor Summary
ExternalStringPointer()
          Creates the pointer to an externally created string.
ExternalStringPointer(boolean unicode)
          Creates the pointer to an externally created string.
ExternalStringPointer(long value)
          Creates the pointer to an externally created string.
ExternalStringPointer(Pointer.Void value)
          Creates the pointer to an externally created string.
 
Method Summary
 boolean isUnicodeString()
          Checks if the external string is the unicode string.
 java.lang.String readString()
          Reads the string from the native site.
 
Methods inherited from class com.jniwrapper.Pointer.Void
asFunction, asFunction, asTypedPointer, castTo, clone, equals, getDebugInfo, getLength, getValue, hashCode, isNull, read, setValue, toString, write
 
Methods inherited from class com.jniwrapper.Parameter
acceptIOPerformer, asReturnValue, dataBufferAssigned, getAlignedLength, getAlignmentRequirement, getDataBuffer, getDataBufferOffset, indent, pop, push, read, setDataBuffer, toByteArray, write
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ExternalStringPointer

public ExternalStringPointer()
Creates the pointer to an externally created string.


ExternalStringPointer

public ExternalStringPointer(boolean unicode)
Creates the pointer to an externally created string.

Parameters:
unicode - specifies if the pointer refers to an unicode string or not.

ExternalStringPointer

public ExternalStringPointer(Pointer.Void value)
Creates the pointer to an externally created string.

Parameters:
value - specifies the pointer to the externally created string.

ExternalStringPointer

public ExternalStringPointer(long value)
Creates the pointer to an externally created string.

Parameters:
value - specifies the value of the pointer to the externally created string.
Method Detail

readString

public java.lang.String readString()
Reads the string from the native site.

Returns:
string from the native site.

isUnicodeString

public boolean isUnicodeString()
Checks if the external string is the unicode string.

Returns:
true if the external string is the unicode string and false otherwise.