java.lang.Object
- com.sun.codemodel.util.Surrogate

```
class Surrogate
extends java.lang.Object
```
Utility class for dealing with surrogates.

Version:

1.11, 03/01/23

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Surrogate.Generator
Surrogate generation support.

static class Surrogate.Parser
Surrogate parsing support.

Field Summary

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

Constructor Summary

Constructors
Modifier Constructor Description

private Surrogate()

Method Summary

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

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

- Field Detail
  - MIN_HIGH
```
public static final char MIN_HIGH
```
    See Also:
    
    Constant Field Values
  - MAX_HIGH
```
public static final char MAX_HIGH
```
    See Also:
    
    Constant Field Values
  - MIN_LOW
```
public static final char MIN_LOW
```
    See Also:
    
    Constant Field Values
  - MAX_LOW
```
public static final char MAX_LOW
```
    See Also:
    
    Constant Field Values
  - MIN
```
public static final char MIN
```
    See Also:
    
    Constant Field Values
  - MAX
```
public static final char MAX
```
    See Also:
    
    Constant Field Values
  - UCS4_MIN
```
public static final int UCS4_MIN
```
    See Also:
    
    Constant Field Values
  - UCS4_MAX
```
public static final int UCS4_MAX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Surrogate
```
private Surrogate()
```
- Method Detail
  - isHigh
```
public static boolean isHigh(int c)
```
    Tells whether or not the given UTF-16 value is a high surrogate.
  - isLow
```
public static boolean isLow(int c)
```
    Tells whether or not the given UTF-16 value is a low surrogate.
  - is
```
public static boolean is(int c)
```
    Tells whether or not the given UTF-16 value is a surrogate character,
  - neededFor
```
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.
  - high
```
public static char high(int uc)
```
    Returns the high UTF-16 surrogate for the given UCS-4 character.
  - low
```
public static char low(int uc)
```
    Returns the low UTF-16 surrogate for the given UCS-4 character.
  - toUCS4
```
public static int toUCS4(char c,
                         char d)
```
    Converts the given surrogate pair into a 32-bit UCS-4 character.

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

Class Surrogate

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_HIGH

MAX_HIGH

MIN_LOW

MAX_LOW

MIN

MAX

UCS4_MIN

UCS4_MAX

Constructor Detail

Surrogate

Method Detail

isHigh

isLow

is

neededFor

high

low

toUCS4