B C D E F G H I L M N O P R S T U W
All Classes All Packages

B

BINARY_BASE64URL_CHARACTERS - Static variable in class io.urf.surf.SURF

The RFC 4648 "base64url" alphabet, without padding characters, used by binary literals.

BINARY_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins binary literal values.

BOOLEAN_FALSE_BEGIN - Static variable in class io.urf.surf.SURF

The beginning delimiter of the lexical form of the Boolean value false.

BOOLEAN_FALSE_LEXICAL_FORM - Static variable in class io.urf.surf.SURF

The lexical representation of the Boolean value false.

BOOLEAN_TRUE_BEGIN - Static variable in class io.urf.surf.SURF

The beginning delimiter of the lexical form of the Boolean value true.

BOOLEAN_TRUE_LEXICAL_FORM - Static variable in class io.urf.surf.SURF

The lexical representation of the Boolean true.

C

CHARACTER_DELIMITER - Static variable in class io.urf.surf.SURF

The delimiter that begins and ends character literal representations.

CHARACTER_ESCAPE - Static variable in class io.urf.surf.SURF

The character used for escaping a character.

CHARACTER_OPTIONAL_ESCAPED_CHARACTERS - Static variable in class io.urf.surf.SURF

Additional characters that may be escaped as characters or in strings.

CHARACTER_REQUIRED_ESCAPED_CHARACTERS - Static variable in class io.urf.surf.SURF

Characters that must be escaped as characters or in strings.

CHARSET - Static variable in class io.urf.surf.SURF

The SURF charset.

checkArgumentValid(String) - Static method in class io.urf.surf.SURF.Handle

Confirms that the given string conforms to the rules for a SURF handle.

checkArgumentValid(String) - Static method in class io.urf.surf.SURF.Name

Confirms that the given string conforms to the rules for a SURF name.

checkArgumentValid(URI) - Static method in class io.urf.surf.SURF.Tag

Ensures that the given URI is a valid resource tag.

checkArgumentValidToken(String) - Static method in class io.urf.surf.SURF.Name

Confirms that the given string conforms to the rules for a SURF name token.

clearProperties() - Method in class io.urf.surf.SurfObject

Removes all properties.

CONTENT_TYPE - Static variable in class io.urf.surf.SURF

The content type for SURF: text/surf.

D

decreaseIndentLevel() - Method in class io.urf.surf.SurfSerializer

Decreases the indention level.

DESCRIPTION_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins an object description.

DESCRIPTION_END - Static variable in class io.urf.surf.SURF

The delimiter that ends a property description.

determineAliasForResource(Object) - Method in class io.urf.surf.SurfSerializer

Determines an alias to use with a resource, generating one if the graph requires it.

discoverResourceReferences(Object) - Method in class io.urf.surf.SurfSerializer

Discovers whether there are references to the given resource and recursively all nested resources.

E

EMAIL_ADDRESS_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins email address literal values.

ENTRY_KEY_VALUE_DELIMITER - Static variable in class io.urf.surf.SURF

The character that separates keys and values in a map entry.

equals(Object) - Method in class io.urf.surf.SurfObject

ESCAPED_BACKSPACE - Static variable in class io.urf.surf.SURF

ESCAPED_CARRIAGE_RETURN - Static variable in class io.urf.surf.SURF

ESCAPED_FORM_FEED - Static variable in class io.urf.surf.SURF

ESCAPED_LINE_FEED - Static variable in class io.urf.surf.SURF

ESCAPED_TAB - Static variable in class io.urf.surf.SURF

ESCAPED_UNICODE - Static variable in class io.urf.surf.SURF

ESCAPED_VERTICAL_TAB - Static variable in class io.urf.surf.SURF

F

FILENAME_EXTENSION - Static variable in class io.urf.surf.SURF

An extension for SURF filenames.

findObjectById(String, String) - Method in class io.urf.surf.SurfParser

Returns a parsed object by its type handle and ID.

findObjectByTag(URI) - Method in class io.urf.surf.SurfParser

Returns a parsed object by its tag.

findResourceByAlias(String) - Method in class io.urf.surf.SurfParser

Returns a parsed resource by its alias.

formatIndent(Appendable) - Method in class io.urf.surf.SurfSerializer

Appends indention characters at the appropriate level if formatting is enabled.

formatNewLine(Appendable) - Method in class io.urf.surf.SurfSerializer

Separates lines by adding a line separation character sequence if formatting is enabled.

G

GENERATED_ALIAS_PREFIX - Static variable in class io.urf.surf.SurfSerializer

The prefix used when generating aliases.

getAliasForResource(Object) - Method in class io.urf.surf.SurfSerializer

Returns any alias associated with a resource.

getId() - Method in class io.urf.surf.SurfObject

Returns the ID, if any, of the object for its type.

getIndentSequence() - Method in class io.urf.surf.SurfSerializer

Returns the sequence of characters used for each indention level.

getLineSeparator() - Method in class io.urf.surf.SurfSerializer

Returns the sequence of characters used to separate lines.

getObjectById(String, String) - Method in class io.urf.surf.SurfParser

Returns a parsed object by its type handle and ID.

getProperties() - Method in class io.urf.surf.SurfObject

getPropertyCount() - Method in class io.urf.surf.SurfObject

getPropertyValue(String) - Method in class io.urf.surf.SurfObject

Retrieves the value of a property by the property handle.

getTag() - Method in class io.urf.surf.SurfObject

getTypeHandle() - Method in class io.urf.surf.SurfObject

H

Handle() - Constructor for class io.urf.surf.SURF.Handle

hasDescription() - Method in class io.urf.surf.SurfObject

hashCode() - Method in class io.urf.surf.SurfObject

I

increaseIndentLevel() - Method in class io.urf.surf.SurfSerializer

Increases the indention level.

io.urf.surf - package io.urf.surf

IRI_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins IRI literal representations.

IRI_END - Static variable in class io.urf.surf.SURF

The delimiter that ends IRI literal representations.

isBeginCharacter(int) - Static method in class io.urf.surf.SURF.Handle

Determines if the given character is valid to begin a SURF handle.

isCompoundResource(Object) - Static method in class io.urf.surf.SurfResources

Deprecated.

Determines whether the given resource is a compound resource, that is, one that can contain other resources.

isFormatted() - Method in class io.urf.surf.SurfSerializer

Returns whether this serializer will format the document with additional whitespace and newlines.

isSequenceSeparatorRequired() - Method in class io.urf.surf.SurfSerializer

Whether separators will always be added between sequence items even if newlines are present.

isSerialized(Object) - Method in class io.urf.surf.SurfSerializer

Determines whether a given resource has already been serialized.

isTokenBeginCharacter(int) - Static method in class io.urf.surf.SURF.Name

Determines if the given character is a SURF token name begin character.

isTokenCharacter(int) - Static method in class io.urf.surf.SURF.Name

Determines if the given character is a SURF name token character.

isValid(String) - Static method in class io.urf.surf.SURF.Handle

Determines whether the given string conforms to the rules for a SURF handle.

isValid(String) - Static method in class io.urf.surf.SURF.Name

Determines whether the given string conforms to the rules for a SURF name.

isValidToken(String) - Static method in class io.urf.surf.SURF.Name

Determines whether the given string conforms to the rules for a SURF name token.

L

LABEL_DELIMITER - Static variable in class io.urf.surf.SURF

The delimiter that begins and ends labels (tags, IDs, and aliases).

LINE_COMMENT_BEGIN - Static variable in class io.urf.surf.SURF

The character indicating the start of a single-line comment.

LIST_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins lists.

LIST_END - Static variable in class io.urf.surf.SURF

The delimiter that ends lists.

M

MAP_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins maps.

MAP_END - Static variable in class io.urf.surf.SURF

The delimiter that ends maps.

MAP_KEY_DELIMITER - Static variable in class io.urf.surf.SURF

The delimiter that optionally begins and ends map keys.

N

Name() - Constructor for class io.urf.surf.SURF.Name

NUMBER_DECIMAL_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins a decimal number.

NUMBER_EXPONENT_DELIMITER_CHARACTERS - Static variable in class io.urf.surf.SURF

The symbols that delimits the exponent part of a number.

NUMBER_EXPONENT_SIGN_CHARACTERS - Static variable in class io.urf.surf.SURF

The symbols that indicate the sign of the exponent part of a number.

NUMBER_FRACTION_DELIMITER - Static variable in class io.urf.surf.SURF

The symbol that delimits the fractional part of a number.

NUMBER_NEGATIVE_SYMBOL - Static variable in class io.urf.surf.SURF

The symbol that indicates a negative number.

O

OBJECT_BEGIN - Static variable in class io.urf.surf.SURF

The indicator of an object (an anonymous resource instance).

P

parse(InputStream) - Method in class io.urf.surf.SurfParser

Parses a SURF resource from an input stream.

parse(Reader) - Method in class io.urf.surf.SurfParser

Parses a SURF resource from a reader.

parse(String) - Method in class io.urf.surf.SurfParser

Parses a SURF resource from a string.

parseBinary(Reader) - Static method in class io.urf.surf.SurfParser

Parses a binary literal.

parseBoolean(Reader) - Static method in class io.urf.surf.SurfParser

Parses a Boolean value.

parseCharacter(Reader) - Static method in class io.urf.surf.SurfParser

Parses a character literal.

parseCharacterCodePoint(Reader, char) - Static method in class io.urf.surf.SurfParser

Parses a character as content, without any delimiters.

parseDescription(Reader, SurfObject) - Method in class io.urf.surf.SurfParser

Parses the description properties of a resource.

parseEmailAddress(Reader) - Static method in class io.urf.surf.SurfParser

Parses an email address.

parseHandle(Reader) - Static method in class io.urf.surf.SurfParser

Parses a handle composed of a name token followed by zero or more name tokens, separated by handle segment delimiters.

parseIRI(Reader) - Static method in class io.urf.surf.SurfParser

Parses an IRI.

parseLabel(Reader) - Static method in class io.urf.surf.SurfParser

Parses a label, surrounded by label delimiters, and which is returned as one of the following: tag The tag IRI as an absolute URI. ID Some object that is neither a URI nor a String and which will provide the ID using Object.toString(). alias An SurfParser.Alias containing the alias string.

parseList(SurfParser.Alias, Reader) - Method in class io.urf.surf.SurfParser

Parses an a list.

parseMap(SurfParser.Alias, Reader) - Method in class io.urf.surf.SurfParser

Parses a map.

parseNameToken(Reader) - Static method in class io.urf.surf.SurfParser

Parses a name token composed of a name token beginning character followed by zero or more name token characters.

parseNumber(Reader) - Static method in class io.urf.surf.SurfParser

Parses a number.

parseObject(Object, Reader) - Method in class io.urf.surf.SurfParser

Parses an object indicated by 42.

parseObject(URI, Reader) - Method in class io.urf.surf.SurfParser

Parses an object, a described resource instance indicated by 42.

parseRegularExpression(Reader) - Static method in class io.urf.surf.SurfParser

Parses a regular expression surrounded by regular expression delimiters and optionally ending with flags.

parseResource(Reader) - Method in class io.urf.surf.SurfParser

Parses a resource; either a tag or a resource representation with an optional description.

parseResource(Reader, boolean) - Method in class io.urf.surf.SurfParser

Parses a resource; either a tag or a resource representation.

parseSequence(Reader, char, IOConsumer<Reader>) - Static method in class io.urf.surf.SurfParser

Parses a general SURF sequence (such as a list).

parseSet(SurfParser.Alias, Reader) - Method in class io.urf.surf.SurfParser

Parses a set.

parseString(Reader) - Static method in class io.urf.surf.SurfParser

Parses a string surrounded by string delimiters.

parseTelephoneNumber(Reader) - Static method in class io.urf.surf.SurfParser

Parses a telephone number.

parseTemporal(Reader) - Static method in class io.urf.surf.SurfParser

Parses a temporal.

parseUuid(Reader) - Static method in class io.urf.surf.SurfParser

Parses a UUID.

PATTERN - Static variable in class io.urf.surf.SURF.Handle

Regular expression pattern to match a SURF handle.

PATTERN - Static variable in class io.urf.surf.SURF.Name

A SURF name is a single name token.

PROPERTY_VALUE_DELIMITER - Static variable in class io.urf.surf.SURF

The character that separates properties and assigned values.

R

REGULAR_EXPRESSION_DELIMITER - Static variable in class io.urf.surf.SURF

The delimiter that begins and ends a regular expressions.

REGULAR_EXPRESSION_ESCAPE - Static variable in class io.urf.surf.SURF

The character used for escaping characters in a regular expression.

S

SEGMENT_DELIMITER - Static variable in class io.urf.surf.SURF.Handle

The delimiter used to separate segments of a SURF handle.

SEQUENCE_DELIMITER - Static variable in class io.urf.surf.SURF

The character that separates items in a sequence.

SEQUENCE_SEPARATOR_CHARACTERS - Static variable in class io.urf.surf.SURF

The sequence separator characters, including the SURF.SEQUENCE_DELIMITER and the EOL characters.

serialize(OutputStream, Object) - Method in class io.urf.surf.SurfSerializer

Serializes a resource graph to an output stream.

serialize(Appendable, Object) - Method in class io.urf.surf.SurfSerializer

Serializes a resource graph to some appendable destination.

serialize(Object) - Method in class io.urf.surf.SurfSerializer

Serializes a resource graph to a string.

serializeBinary(Appendable, byte[]) - Static method in class io.urf.surf.SurfSerializer

Serializes a binary literal along with its delimiter from an array of bytes.

serializeBinary(Appendable, ByteBuffer) - Static method in class io.urf.surf.SurfSerializer

Serializes a binary literal along with its delimiter from a byte buffer.

serializeBoolean(Appendable, boolean) - Static method in class io.urf.surf.SurfSerializer

Serializes a Boolean.

serializeCharacter(Appendable, int) - Static method in class io.urf.surf.SurfSerializer

Serializes a character surrounded by character delimiters.

serializeCharacterCodePoint(Appendable, char, int) - Static method in class io.urf.surf.SurfSerializer

Serializes a character as content, without any delimiters.

serializeDescription(Appendable, SurfObject) - Method in class io.urf.surf.SurfSerializer

Serializes a resource description.

serializeEmailAddress(Appendable, EmailAddress) - Static method in class io.urf.surf.SurfSerializer

Serializes an email address along with its delimiter.

serializeIri(Appendable, URI) - Static method in class io.urf.surf.SurfSerializer

Serializes an IRI along with its delimiters.

serializeList(Appendable, List<?>) - Method in class io.urf.surf.SurfSerializer

Serializes a list.

serializeMap(Appendable, Map<?, ?>) - Method in class io.urf.surf.SurfSerializer

Serializes a map.

serializeNumber(Appendable, Number) - Static method in class io.urf.surf.SurfSerializer

Serializes a number along with its delimiter if should be represented as a decimal.

serializeObject(Appendable, SurfObject) - Method in class io.urf.surf.SurfSerializer

Serializes a object representation without the following description.

serializeRegularExpression(Appendable, Pattern) - Static method in class io.urf.surf.SurfSerializer

Serializes a regular expression along with its delimiters.

serializeResource(Appendable, Object) - Method in class io.urf.surf.SurfSerializer

Serializes a resource to some appendable destination.

serializeSequence(Appendable, Iterable<I>, IOBiConsumer<Appendable, I>) - Method in class io.urf.surf.SurfSerializer

Serializes a general sequence (such as a list).

serializeSet(Appendable, Set<?>) - Method in class io.urf.surf.SurfSerializer

Serializes a set.

serializeString(Appendable, CharSequence) - Static method in class io.urf.surf.SurfSerializer

Serializes a string surrounded by string delimiters.

serializeTelephoneNumber(Appendable, TelephoneNumber) - Static method in class io.urf.surf.SurfSerializer

Serializes a telephone number along with its delimiter.

serializeTemporal(Appendable, TemporalAccessor) - Static method in class io.urf.surf.SurfSerializer

Serializes a temporal literal along with its delimiter.

serializeUuid(Appendable, UUID) - Static method in class io.urf.surf.SurfSerializer

Serializes a UUID along with its delimiter.

SET_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins sets.

SET_END - Static variable in class io.urf.surf.SURF

The delimiter that ends sets.

setAliasForResource(Object, String) - Method in class io.urf.surf.SurfSerializer

Associates an alias with a resource.

setFormatted(boolean) - Method in class io.urf.surf.SurfSerializer

Sets whether the serialization should be formatted.

setIndentSequence(CharSequence) - Method in class io.urf.surf.SurfSerializer

Set the sequence of characters used for each indention level.

setLineSeparator(CharSequence) - Method in class io.urf.surf.SurfSerializer

Sets the sequence of characters used to separate lines.

setProperties(Map<String, ?>) - Method in class io.urf.surf.SurfObject

Sets property values from a map of property handles and values.

setPropertyValue(String, Object) - Method in class io.urf.surf.SurfObject

Sets a property value by the property handle.

setSequenceSeparatorRequired(boolean) - Method in class io.urf.surf.SurfSerializer

Sets whether separators will always be added between sequence items even if newlines are present.

setSerialized(Object) - Method in class io.urf.surf.SurfSerializer

Sets a resource has having been serialized.

skipFiller(Reader) - Static method in class io.urf.surf.SurfParser

Skips over SURF filler in a reader, including whitespace and line comments.

skipLineBreaks(Reader) - Static method in class io.urf.surf.SurfParser

Skips over SURF line breaks in a reader, including whitespace and line comments.

skipSequenceDelimiters(Reader) - Static method in class io.urf.surf.SurfParser

Skips over SURF sequence delimiters in a reader.

STRING_DELIMITER - Static variable in class io.urf.surf.SURF

The delimiter that begins and ends string literal representations.

SURF - Class in io.urf.surf

Definitions for the Simple URF (SURF) document format.

SURF() - Constructor for class io.urf.surf.SURF

SURF.Handle - Class in io.urf.surf

Utilities for working with SURF handles.

SURF.Name - Class in io.urf.surf

Utilities for working with SURF names.

SURF.Tag - Class in io.urf.surf

Utilities for working with SURF tags.

SurfObject - Class in io.urf.surf

A SURF object for a SURF document.

SurfObject() - Constructor for class io.urf.surf.SurfObject

Constructor of a object with no tag and an unknown type.

SurfObject(String) - Constructor for class io.urf.surf.SurfObject

Optional type handle constructor.

SurfObject(String, String) - Constructor for class io.urf.surf.SurfObject

Type handle and optional ID constructor.

SurfObject(URI) - Constructor for class io.urf.surf.SurfObject

Optional tag constructor.

SurfObject(URI, String) - Constructor for class io.urf.surf.SurfObject

Optional tag and optional type handle constructor.

SurfParser - Class in io.urf.surf

Simple parser for the Simple URF (SURF) document format.

SurfParser() - Constructor for class io.urf.surf.SurfParser

SurfResources - Class in io.urf.surf

Deprecated.

TODO move to SurfSerializer

SurfResources() - Constructor for class io.urf.surf.SurfResources

Deprecated.

SurfSerializer - Class in io.urf.surf

Simple serializer for the Simple URF (SURF) document format.

SurfSerializer() - Constructor for class io.urf.surf.SurfSerializer

T

Tag() - Constructor for class io.urf.surf.SURF.Tag

TELEPHONE_NUMBER_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins telephone number literal values.

TEMPORAL_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins temporal literal representations.

TEMPORAL_ZONE_BEGIN - Static variable in class io.urf.surf.SURF

The ISO 8601 extension delimiter indicating the start of a time zone designation.

TEMPORAL_ZONE_END - Static variable in class io.urf.surf.SURF

The ISO 8601 extension delimiter indicating the end of a time zone designation.

TOKEN_PATTERN - Static variable in class io.urf.surf.SURF.Name

Regular expression pattern to match a SURF name token .

U

UUID_BEGIN - Static variable in class io.urf.surf.SURF

The delimiter that begins UUID literal representations.

UUID_GROUP_DELIMITER - Static variable in class io.urf.surf.SURF

The delimiter that separates internal groups of UUID hexadecimal digits.

W

WHITESPACE_CHARACTERS - Static variable in class io.urf.surf.SURF

Characters recognized as whitespace.

WHITESPACE_EOL_CHARACTERS - Static variable in class io.urf.surf.SurfParser

Whitespace and end-of-line characters.

B C D E F G H I L M N O P R S T U W
All Classes All Packages