Modifier and Type	Class and Description
public static class	Surrogate.Generator Surrogate generation support.
public static class	Surrogate.Parser Surrogate parsing support.

Modifier and Type	Field and Description
public static final char	MAX
public static final char	MAX_HIGH
public static final char	MAX_LOW
public static final char	MIN
public static final char	MIN_HIGH
public static final char	MIN_LOW
public static final int	UCS4_MAX
public static final int	UCS4_MIN

Access	Constructor and Description
private	Surrogate()

Method Summary

Modifier and Type	Method and Description
public static char	high(int uc) Returns the high UTF-16 surrogate for the given supplementary UCS-4 character.
public static boolean	is(int c) Tells whether or not the given value is in the surrogate range.
public static boolean	isHigh(int c) Tells whether or not the given value is in the high surrogate range.
public static boolean	isLow(int c) Tells whether or not the given value is in the low surrogate range.
public static char	low(int uc) Returns the low UTF-16 surrogate for the given supplementary UCS-4 character.
public static boolean	neededFor(int uc) Tells whether or not the given UCS-4 character must be represented as a surrogate pair in UTF-16.
public static int	toUCS4(char c, char d) Converts the given surrogate pair into a 32-bit UCS-4 character.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

MAX	back to summary
public static final char MAX

MAX_HIGH	back to summary
public static final char MAX_HIGH

MAX_LOW	back to summary
public static final char MAX_LOW

MIN	back to summary
public static final char MIN

MIN_HIGH	back to summary
public static final char MIN_HIGH

MIN_LOW	back to summary
public static final char MIN_LOW

UCS4_MAX	back to summary
public static final int UCS4_MAX

UCS4_MIN	back to summary
public static final int UCS4_MIN

Surrogate	back to summary
private Surrogate()

Method Detail

high	back to summary
public static char high(int uc) Returns the high UTF-16 surrogate for the given supplementary UCS-4 character. Use of `Character#highSurrogate` is generally preferred.

is	back to summary
public static boolean is(int c) Tells whether or not the given value is in the surrogate range. Use of `Character#isSurrogate` is generally preferred.

isHigh	back to summary
public static boolean isHigh(int c) Tells whether or not the given value is in the high surrogate range. Use of `Character#isHighSurrogate` is generally preferred.

isLow	back to summary
public static boolean isLow(int c) Tells whether or not the given value is in the low surrogate range. Use of `Character#isLowSurrogate` is generally preferred.

low	back to summary
public static char low(int uc) Returns the low UTF-16 surrogate for the given supplementary UCS-4 character. Use of `Character#lowSurrogate` is generally preferred.

neededFor	back to summary
public static boolean neededFor(int uc) Tells whether or not the given UCS-4 character must be represented as a surrogate pair in UTF-16. Use of `Character#isSupplementaryCodePoint` is generally preferred.

toUCS4	back to summary
public static int toUCS4(char c, char d) Converts the given surrogate pair into a 32-bit UCS-4 character. Use of `Character#toCodePoint` is generally preferred.

sun.nio.cs back to summary

public Class Surrogate.Generator

Class Inheritance

extends Object

java.lang.Object
sun.nio.cs.Surrogate.Generator

Surrogate generation support. Charset implementations may use instances of this class to handle the details of generating UTF-16 surrogate pairs.

Field Summary

Modifier and Type	Field and Description
private CoderResult	error

Constructor Summary

Access	Constructor and Description
public	Generator()

Method Summary

Modifier and Type	Method and Description
public CoderResult	error() If the previous generation operation detected an error, return the object describing that error.
public int	Returns: Either a positive count of the number of UTF-16 characters written to the destination buffer, or -1, in which case error() will return a descriptive result object generate(int The UCS-4 character uc, int The number of input bytes from which the UCS-4 value was constructed (used when creating result objects) len, CharBuffer The destination buffer, to which one or two UTF-16 characters will be written dst) Generates one or two UTF-16 characters to represent the given UCS-4 character.
public int	Returns: Either a positive count of the number of UTF-16 characters written to the destination buffer, or -1, in which case error() will return a descriptive result object generate(int The UCS-4 character uc, int The number of input bytes from which the UCS-4 value was constructed (used when creating result objects) len, char[] The destination array, to which one or two UTF-16 characters will be written da, int The destination position dp, int The destination limit dl) Generates one or two UTF-16 characters to represent the given UCS-4 character.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

error	back to summary
private CoderResult error

Constructor Detail

Generator	back to summary
public Generator()

Method Detail

error	back to summary
public CoderResult error() If the previous generation operation detected an error, return the object describing that error.

generate	back to summary
public int generate(int uc, int len, CharBuffer dst) Generates one or two UTF-16 characters to represent the given UCS-4 character. Parameters uc:int The UCS-4 character len:int The number of input bytes from which the UCS-4 value was constructed (used when creating result objects) dst:CharBuffer The destination buffer, to which one or two UTF-16 characters will be written Returns:int Either a positive count of the number of UTF-16 characters written to the destination buffer, or -1, in which case error() will return a descriptive result object

generate

back to summary

public int generate(int uc, int len, CharBuffer dst)

Generates one or two UTF-16 characters to represent the given UCS-4 character.

Parameters

uc:int: The UCS-4 character
len:int: The number of input bytes from which the UCS-4 value was constructed (used when creating result objects)
dst:CharBuffer: The destination buffer, to which one or two UTF-16 characters will be written

Returns:int

Either a positive count of the number of UTF-16 characters written to the destination buffer, or -1, in which case error() will return a descriptive result object

generate	back to summary
public int generate(int uc, int len, char[] da, int dp, int dl) Generates one or two UTF-16 characters to represent the given UCS-4 character. Parameters uc:int The UCS-4 character len:int The number of input bytes from which the UCS-4 value was constructed (used when creating result objects) da:char[] The destination array, to which one or two UTF-16 characters will be written dp:int The destination position dl:int The destination limit Returns:int Either a positive count of the number of UTF-16 characters written to the destination buffer, or -1, in which case error() will return a descriptive result object

generate

back to summary

public int generate(int uc, int len, char[] da, int dp, int dl)

Generates one or two UTF-16 characters to represent the given UCS-4 character.

Parameters

uc:int: The UCS-4 character
len:int: The number of input bytes from which the UCS-4 value was constructed (used when creating result objects)
da:char[]: The destination array, to which one or two UTF-16 characters will be written
dp:int: The destination position
dl:int: The destination limit

Returns:int

Either a positive count of the number of UTF-16 characters written to the destination buffer, or -1, in which case error() will return a descriptive result object

sun.nio.cs back to summary

public Class Surrogate.Parser

Class Inheritance

extends Object

java.lang.Object
sun.nio.cs.Surrogate.Parser

Surrogate parsing support. Charset implementations may use instances of this class to handle the details of parsing UTF-16 surrogate pairs.

Field Summary

Modifier and Type	Field and Description
private int	character
private CoderResult	error
private boolean	isPair

Constructor Summary

Access	Constructor and Description
public	Parser()

Method Summary

Modifier and Type	Method and Description
public int	character() Returns the UCS-4 character previously parsed.
public CoderResult	error() If the previous parse operation detected an error, return the object describing that error.
public int	increment() Returns the number of UTF-16 characters consumed by the previous parse.
public boolean	isPair() Tells whether or not the previously-parsed UCS-4 character was originally represented by a surrogate pair.
public int	Returns: Either a parsed UCS-4 character, in which case the isPair() and increment() methods will return meaningful values, or -1, in which case error() will return a descriptive result object parse(char The first character c, CharBuffer The source buffer, from which one more character will be consumed if c is a high surrogate in) Parses a UCS-4 character from the given source buffer, handling surrogates.
public int	Returns: Either a parsed UCS-4 character, in which case the isPair() and increment() methods will return meaningful values, or -1, in which case error() will return a descriptive result object parse(char The first character c, char[] The input array, from which one more character will be consumed if c is a high surrogate ia, int The input index ip, int The input limit il) Parses a UCS-4 character from the given source buffer, handling surrogates.
public CoderResult	unmappableResult() Returns an unmappable-input result object, with the appropriate input length, for the previously-parsed character.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

character	back to summary
private int character

error	back to summary
private CoderResult error

isPair	back to summary
private boolean isPair

Constructor Detail

Parser	back to summary
public Parser()

Method Detail

character	back to summary
public int character() Returns the UCS-4 character previously parsed.

error	back to summary
public CoderResult error() If the previous parse operation detected an error, return the object describing that error.

increment	back to summary
public int increment() Returns the number of UTF-16 characters consumed by the previous parse.

isPair	back to summary
public boolean isPair() Tells whether or not the previously-parsed UCS-4 character was originally represented by a surrogate pair.

parse	back to summary
public int parse(char c, CharBuffer in) Parses a UCS-4 character from the given source buffer, handling surrogates. Parameters c:char The first character in:CharBuffer The source buffer, from which one more character will be consumed if c is a high surrogate Returns:int Either a parsed UCS-4 character, in which case the isPair() and increment() methods will return meaningful values, or -1, in which case error() will return a descriptive result object

parse

back to summary

public int parse(char c, CharBuffer in)

Parses a UCS-4 character from the given source buffer, handling surrogates.

Parameters

c:char: The first character
in:CharBuffer: The source buffer, from which one more character will be consumed if c is a high surrogate

Returns:int

Either a parsed UCS-4 character, in which case the isPair() and increment() methods will return meaningful values, or -1, in which case error() will return a descriptive result object

parse	back to summary
public int parse(char c, char[] ia, int ip, int il) Parses a UCS-4 character from the given source buffer, handling surrogates. Parameters c:char The first character ia:char[] The input array, from which one more character will be consumed if c is a high surrogate ip:int The input index il:int The input limit Returns:int Either a parsed UCS-4 character, in which case the isPair() and increment() methods will return meaningful values, or -1, in which case error() will return a descriptive result object

parse

back to summary

public int parse(char c, char[] ia, int ip, int il)

Parses a UCS-4 character from the given source buffer, handling surrogates.

Parameters

c:char: The first character
ia:char[]: The input array, from which one more character will be consumed if c is a high surrogate
ip:int: The input index
il:int: The input limit

Returns:int

Either a parsed UCS-4 character, in which case the isPair() and increment() methods will return meaningful values, or -1, in which case error() will return a descriptive result object

unmappableResult	back to summary
public CoderResult unmappableResult() Returns an unmappable-input result object, with the appropriate input length, for the previously-parsed character.

public Class Surrogate

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Surrogate.Generator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Surrogate.Parser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail