SURF (SURF 0.2.0 API)

java.lang.Object
- io.urf.surf.SURF

```
public class SURF
extends Object
```
Definitions for the Simple URF (SURF) document format.

Author:

Garret Wilson

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SURF.Handle` Utilities for working with SURF handles.
`static class`	`SURF.Name` Utilities for working with SURF names.
`static class`	`SURF.Tag` Utilities for working with SURF tags.

Field Summary

Fields
Modifier and Type	Field and Description
`static com.globalmentor.java.Characters`	`BINARY_BASE64URL_CHARACTERS` The RFC 4648 "base64url" alphabet, without padding characters, used by SURF binary literals.
`static char`	`BINARY_BEGIN` The delimiter that begins binary literal values.
`static char`	`BOOLEAN_FALSE_BEGIN` The beginning delimiter of the lexical form of the Boolean value `false`.
`static String`	`BOOLEAN_FALSE_LEXICAL_FORM` The lexical representation of the Boolean value `false`.
`static char`	`BOOLEAN_TRUE_BEGIN` The beginning delimiter of the lexical form of the Boolean value `true`.
`static String`	`BOOLEAN_TRUE_LEXICAL_FORM` The lexical representation of the Boolean `true`.
`static char`	`CHARACTER_DELIMITER` The delimiter that begins and ends character literal representations.
`static char`	`CHARACTER_ESCAPE` The character used for escaping a character.
`static com.globalmentor.java.Characters`	`CHARACTER_OPTIONAL_ESCAPED_CHARACTERS` Additional SURF characters that may be escaped as characters or in strings.
`static com.globalmentor.java.Characters`	`CHARACTER_REQUIRED_ESCAPED_CHARACTERS` SURF characters that must be escaped as characters or in strings.
`static Charset`	`CHARSET` The SURF charset.
`static char`	`DESCRIPTION_BEGIN` The delimiter that begins an object description.
`static char`	`DESCRIPTION_END` The delimiter that ends a property description.
`static char`	`EMAIL_ADDRESS_BEGIN` The delimiter that begins email address literal values.
`static char`	`ENTRY_KEY_VALUE_DELIMITER` The character that separates keys and values in a map entry.
`static char`	`ESCAPED_BACKSPACE`
`static char`	`ESCAPED_CARRIAGE_RETURN`
`static char`	`ESCAPED_FORM_FEED`
`static char`	`ESCAPED_LINE_FEED`
`static char`	`ESCAPED_TAB`
`static char`	`ESCAPED_UNICODE`
`static char`	`ESCAPED_VERTICAL_TAB`
`static char`	`IRI_BEGIN` The delimiter that begins IRI literal representations.
`static char`	`IRI_END` The delimiter that ends IRI literal representations.
`static char`	`LABEL_DELIMITER` The delimiter that begins and ends labels (tags, IDs, and aliases).
`static char`	`LINE_COMMENT_BEGIN` The character indicating the start of a Surf single-line comment.
`static char`	`LIST_BEGIN` The delimiter that begins lists.
`static char`	`LIST_END` The delimiter that ends lists.
`static char`	`MAP_BEGIN` The delimiter that begins maps.
`static char`	`MAP_END` The delimiter that ends maps.
`static char`	`MAP_KEY_DELIMITER` The delimiter that optionally begins and ends map keys.
`static char`	`NUMBER_DECIMAL_BEGIN` The delimiter that begins a decimal number.
`static com.globalmentor.java.Characters`	`NUMBER_EXPONENT_DELIMITER_CHARACTERS` The symbols that delimits the exponent part of a number.
`static com.globalmentor.java.Characters`	`NUMBER_EXPONENT_SIGN_CHARACTERS` The symbols that indicate the sign of the exponent part of a number.
`static char`	`NUMBER_FRACTION_DELIMITER` The symbol that delimits the fractional part of a number.
`static char`	`NUMBER_NEGATIVE_SYMBOL` The symbol that indicates a negative number.
`static char`	`OBJECT_BEGIN` The indicator of an object (an anonymous resource instance).
`static char`	`PROPERTY_VALUE_DELIMITER` The character that separates properties and assigned values.
`static char`	`REGULAR_EXPRESSION_DELIMITER` The delimiter that begins and ends a regular expressions.
`static char`	`REGULAR_EXPRESSION_ESCAPE` The character used for escaping characters in a regular expression.
`static char`	`SEQUENCE_DELIMITER` The character that separates items in a sequence.
`static com.globalmentor.java.Characters`	`SEQUENCE_SEPARATOR_CHARACTERS` The SURF sequence separator characters, including the `SEQUENCE_DELIMITER` and the EOL characters.
`static char`	`SET_BEGIN` The delimiter that begins sets.
`static char`	`SET_END` The delimiter that ends sets.
`static char`	`STRING_DELIMITER` The delimiter that begins and ends string literal representations.
`static char`	`TELEPHONE_NUMBER_BEGIN` The delimiter that begins telephone number literal values.
`static char`	`TEMPORAL_BEGIN` The delimiter that begins temporal literal representations.
`static char`	`TEMPORAL_ZONE_BEGIN` The ISO 8601 extension delimiter indicating the start of a time zone designation.
`static char`	`TEMPORAL_ZONE_END` The ISO 8601 extension delimiter indicating the end of a time zone designation.
`static char`	`UUID_BEGIN` The delimiter that begins UUID literal representations.
`static char`	`UUID_GROUP_DELIMITER` The delimiter that separates internal groups of UUID hexadecimal digits.
`static com.globalmentor.java.Characters`	`WHITESPACE_CHARACTERS` Characters recognized by SURF as whitespace.

Constructor Summary

Constructors
Constructor and Description

SURF()

Constructors
Constructor and Description
`SURF()`

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

- Field Detail
  - CHARSET
```
public static final Charset CHARSET
```
    The SURF charset.
  - WHITESPACE_CHARACTERS
```
public static final com.globalmentor.java.Characters WHITESPACE_CHARACTERS
```
    Characters recognized by SURF as whitespace.
  - SEQUENCE_DELIMITER
```
public static final char SEQUENCE_DELIMITER
```
    The character that separates items in a sequence.
    
    See Also:
    
    Constant Field Values
  - SEQUENCE_SEPARATOR_CHARACTERS
```
public static final com.globalmentor.java.Characters SEQUENCE_SEPARATOR_CHARACTERS
```
    The SURF sequence separator characters, including the SEQUENCE_DELIMITER and the EOL characters.
  - LINE_COMMENT_BEGIN
```
public static final char LINE_COMMENT_BEGIN
```
    The character indicating the start of a Surf single-line comment.
    
    See Also:
    
    Constant Field Values
  - LABEL_DELIMITER
```
public static final char LABEL_DELIMITER
```
    The delimiter that begins and ends labels (tags, IDs, and aliases).
    
    See Also:
    
    Constant Field Values
  - OBJECT_BEGIN
```
public static final char OBJECT_BEGIN
```
    The indicator of an object (an anonymous resource instance).
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION_BEGIN
```
public static final char DESCRIPTION_BEGIN
```
    The delimiter that begins an object description.
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION_END
```
public static final char DESCRIPTION_END
```
    The delimiter that ends a property description.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_VALUE_DELIMITER
```
public static final char PROPERTY_VALUE_DELIMITER
```
    The character that separates properties and assigned values.
    
    See Also:
    
    Constant Field Values
  - BINARY_BEGIN
```
public static final char BINARY_BEGIN
```
    The delimiter that begins binary literal values.
    
    See Also:
    
    Constant Field Values
  - BINARY_BASE64URL_CHARACTERS
```
public static final com.globalmentor.java.Characters BINARY_BASE64URL_CHARACTERS
```
    The RFC 4648 "base64url" alphabet, without padding characters, used by SURF binary literals.
  - BOOLEAN_FALSE_LEXICAL_FORM
```
public static final String BOOLEAN_FALSE_LEXICAL_FORM
```
    The lexical representation of the Boolean value false.
    
    See Also:
    
    Constant Field Values
  - BOOLEAN_TRUE_LEXICAL_FORM
```
public static final String BOOLEAN_TRUE_LEXICAL_FORM
```
    The lexical representation of the Boolean true.
    
    See Also:
    
    Constant Field Values
  - BOOLEAN_FALSE_BEGIN
```
public static final char BOOLEAN_FALSE_BEGIN
```
    The beginning delimiter of the lexical form of the Boolean value false.
    
    See Also:
    
    Constant Field Values
  - BOOLEAN_TRUE_BEGIN
```
public static final char BOOLEAN_TRUE_BEGIN
```
    The beginning delimiter of the lexical form of the Boolean value true.
    
    See Also:
    
    Constant Field Values
  - CHARACTER_DELIMITER
```
public static final char CHARACTER_DELIMITER
```
    The delimiter that begins and ends character literal representations.
    
    See Also:
    
    Constant Field Values
  - CHARACTER_ESCAPE
```
public static final char CHARACTER_ESCAPE
```
    The character used for escaping a character.
    
    See Also:
    
    Constant Field Values
  - CHARACTER_REQUIRED_ESCAPED_CHARACTERS
```
public static com.globalmentor.java.Characters CHARACTER_REQUIRED_ESCAPED_CHARACTERS
```
    SURF characters that must be escaped as characters or in strings.
  - CHARACTER_OPTIONAL_ESCAPED_CHARACTERS
```
public static com.globalmentor.java.Characters CHARACTER_OPTIONAL_ESCAPED_CHARACTERS
```
    Additional SURF characters that may be escaped as characters or in strings.
  - ESCAPED_BACKSPACE
```
public static final char ESCAPED_BACKSPACE
```
    See Also:
    
    Constant Field Values
  - ESCAPED_FORM_FEED
```
public static final char ESCAPED_FORM_FEED
```
    See Also:
    
    Constant Field Values
  - ESCAPED_LINE_FEED
```
public static final char ESCAPED_LINE_FEED
```
    See Also:
    
    Constant Field Values
  - ESCAPED_CARRIAGE_RETURN
```
public static final char ESCAPED_CARRIAGE_RETURN
```
    See Also:
    
    Constant Field Values
  - ESCAPED_TAB
```
public static final char ESCAPED_TAB
```
    See Also:
    
    Constant Field Values
  - ESCAPED_VERTICAL_TAB
```
public static final char ESCAPED_VERTICAL_TAB
```
    See Also:
    
    Constant Field Values
  - ESCAPED_UNICODE
```
public static final char ESCAPED_UNICODE
```
    See Also:
    
    Constant Field Values
  - EMAIL_ADDRESS_BEGIN
```
public static final char EMAIL_ADDRESS_BEGIN
```
    The delimiter that begins email address literal values.
    
    See Also:
    
    Constant Field Values
  - IRI_BEGIN
```
public static final char IRI_BEGIN
```
    The delimiter that begins IRI literal representations.
    
    See Also:
    
    Constant Field Values
  - IRI_END
```
public static final char IRI_END
```
    The delimiter that ends IRI literal representations.
    
    See Also:
    
    Constant Field Values
  - NUMBER_DECIMAL_BEGIN
```
public static final char NUMBER_DECIMAL_BEGIN
```
    The delimiter that begins a decimal number.
    
    See Also:
    
    Constant Field Values
  - NUMBER_FRACTION_DELIMITER
```
public static final char NUMBER_FRACTION_DELIMITER
```
    The symbol that delimits the fractional part of a number.
    
    See Also:
    
    Constant Field Values
  - NUMBER_EXPONENT_DELIMITER_CHARACTERS
```
public static final com.globalmentor.java.Characters NUMBER_EXPONENT_DELIMITER_CHARACTERS
```
    The symbols that delimits the exponent part of a number.
  - NUMBER_EXPONENT_SIGN_CHARACTERS
```
public static final com.globalmentor.java.Characters NUMBER_EXPONENT_SIGN_CHARACTERS
```
    The symbols that indicate the sign of the exponent part of a number.
  - NUMBER_NEGATIVE_SYMBOL
```
public static final char NUMBER_NEGATIVE_SYMBOL
```
    The symbol that indicates a negative number.
    
    See Also:
    
    Constant Field Values
  - REGULAR_EXPRESSION_DELIMITER
```
public static final char REGULAR_EXPRESSION_DELIMITER
```
    The delimiter that begins and ends a regular expressions.
    
    See Also:
    
    Constant Field Values
  - REGULAR_EXPRESSION_ESCAPE
```
public static final char REGULAR_EXPRESSION_ESCAPE
```
    The character used for escaping characters in a regular expression.
    
    See Also:
    
    Constant Field Values
  - STRING_DELIMITER
```
public static final char STRING_DELIMITER
```
    The delimiter that begins and ends string literal representations.
    
    See Also:
    
    Constant Field Values
  - TELEPHONE_NUMBER_BEGIN
```
public static final char TELEPHONE_NUMBER_BEGIN
```
    The delimiter that begins telephone number literal values.
    
    See Also:
    
    Constant Field Values
  - TEMPORAL_BEGIN
```
public static final char TEMPORAL_BEGIN
```
    The delimiter that begins temporal literal representations.
    
    See Also:
    
    Constant Field Values
  - TEMPORAL_ZONE_BEGIN
```
public static final char TEMPORAL_ZONE_BEGIN
```
    The ISO 8601 extension delimiter indicating the start of a time zone designation.
    
    See Also:
    
    Constant Field Values
  - TEMPORAL_ZONE_END
```
public static final char TEMPORAL_ZONE_END
```
    The ISO 8601 extension delimiter indicating the end of a time zone designation.
    
    See Also:
    
    Constant Field Values
  - UUID_BEGIN
```
public static final char UUID_BEGIN
```
    The delimiter that begins UUID literal representations.
    
    See Also:
    
    Constant Field Values
  - UUID_GROUP_DELIMITER
```
public static final char UUID_GROUP_DELIMITER
```
    The delimiter that separates internal groups of UUID hexadecimal digits.
    
    See Also:
    
    Constant Field Values
  - LIST_BEGIN
```
public static final char LIST_BEGIN
```
    The delimiter that begins lists.
    
    See Also:
    
    Constant Field Values
  - LIST_END
```
public static final char LIST_END
```
    The delimiter that ends lists.
    
    See Also:
    
    Constant Field Values
  - MAP_BEGIN
```
public static final char MAP_BEGIN
```
    The delimiter that begins maps.
    
    See Also:
    
    Constant Field Values
  - MAP_END
```
public static final char MAP_END
```
    The delimiter that ends maps.
    
    See Also:
    
    Constant Field Values
  - MAP_KEY_DELIMITER
```
public static final char MAP_KEY_DELIMITER
```
    The delimiter that optionally begins and ends map keys.
    
    See Also:
    
    Constant Field Values
  - ENTRY_KEY_VALUE_DELIMITER
```
public static final char ENTRY_KEY_VALUE_DELIMITER
```
    The character that separates keys and values in a map entry.
    
    See Also:
    
    Constant Field Values
  - SET_BEGIN
```
public static final char SET_BEGIN
```
    The delimiter that begins sets.
    
    See Also:
    
    Constant Field Values
  - SET_END
```
public static final char SET_END
```
    The delimiter that ends sets.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SURF
```
public SURF()
```

Class SURF

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CHARSET

WHITESPACE_CHARACTERS

SEQUENCE_DELIMITER

SEQUENCE_SEPARATOR_CHARACTERS

LINE_COMMENT_BEGIN

LABEL_DELIMITER

OBJECT_BEGIN

DESCRIPTION_BEGIN

DESCRIPTION_END

PROPERTY_VALUE_DELIMITER

BINARY_BEGIN

BINARY_BASE64URL_CHARACTERS

BOOLEAN_FALSE_LEXICAL_FORM

BOOLEAN_TRUE_LEXICAL_FORM

BOOLEAN_FALSE_BEGIN

BOOLEAN_TRUE_BEGIN

CHARACTER_DELIMITER

CHARACTER_ESCAPE

CHARACTER_REQUIRED_ESCAPED_CHARACTERS

CHARACTER_OPTIONAL_ESCAPED_CHARACTERS

ESCAPED_BACKSPACE

ESCAPED_FORM_FEED

ESCAPED_LINE_FEED

ESCAPED_CARRIAGE_RETURN

ESCAPED_TAB

ESCAPED_VERTICAL_TAB

ESCAPED_UNICODE

EMAIL_ADDRESS_BEGIN

IRI_BEGIN

IRI_END

NUMBER_DECIMAL_BEGIN

NUMBER_FRACTION_DELIMITER

NUMBER_EXPONENT_DELIMITER_CHARACTERS

NUMBER_EXPONENT_SIGN_CHARACTERS

NUMBER_NEGATIVE_SYMBOL

REGULAR_EXPRESSION_DELIMITER

REGULAR_EXPRESSION_ESCAPE

STRING_DELIMITER

TELEPHONE_NUMBER_BEGIN

TEMPORAL_BEGIN

TEMPORAL_ZONE_BEGIN

TEMPORAL_ZONE_END

UUID_BEGIN

UUID_GROUP_DELIMITER

LIST_BEGIN

LIST_END

MAP_BEGIN

MAP_END

MAP_KEY_DELIMITER

ENTRY_KEY_VALUE_DELIMITER

SET_BEGIN

SET_END

Constructor Detail

SURF