A B C E F G H I L N O P R S T U V W

A

addRule(String, String, SyntaxStyle) - Method in class com.github.mangstadt.vinnie.io.SyntaxRules

Adds a rule.

allow(int, int) - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Allow characters within the given range.

allow(String) - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Allow all the characters in the given string.

allow(char) - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Allow the given character.

allowAll() - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Allow all characters.

AllowedCharacters - Class in com.github.mangstadt.vinnie.validate

Validates whether or not strings contain only certain characters.

AllowedCharacters(BitSet, boolean) - Constructor for class com.github.mangstadt.vinnie.validate.AllowedCharacters

Creates an allowed character list based on the given BitSet.

AllowedCharacters.Builder - Class in com.github.mangstadt.vinnie.validate

Builder class for creating new instances of AllowedCharacters.

allowedCharactersGroup(SyntaxStyle, boolean) - Static method in class com.github.mangstadt.vinnie.validate.VObjectValidator

Gets the list of allowed characters for group names.

allowedCharactersParameterName(SyntaxStyle, boolean) - Static method in class com.github.mangstadt.vinnie.validate.VObjectValidator

Gets the list of allowed characters for parameter names.

allowedCharactersParameterValue(SyntaxStyle, boolean, boolean) - Static method in class com.github.mangstadt.vinnie.validate.VObjectValidator

Gets the list of allowed characters for parameter values.

allowedCharactersPropertyName(SyntaxStyle, boolean) - Static method in class com.github.mangstadt.vinnie.validate.VObjectValidator

Gets the list of allowed characters for property names.

allowNonAscii() - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Allows all characters outside the range of 7-bit ASCII.

allowPrintable() - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Allows all characters that are considered "printable" (32-126 inclusive).

append(Object) - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.SemiStructuredValueBuilder

Appends a value to the semi-structured value.

append(Object) - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueBuilder

Appends a single-valued component.

append(List<?>) - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueBuilder

Appends a component.

B

bitSet() - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters

Gets the underlying BitSet object.

build(boolean, boolean) - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.SemiStructuredValueBuilder

Builds the semi-structured value string.

build() - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueBuilder

Builds the structured value string.

build(boolean) - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueBuilder

Builds the structured value string.

build() - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Constructs the final AllowedCharacters object.

Builder() - Constructor for class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Creates a new builder.

Builder(AllowedCharacters) - Constructor for class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Initializes the builder with an existing AllowedCharacters object.

C

check(String) - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters

Determines if a string only contains allowed characters.

clear() - Method in class com.github.mangstadt.vinnie.VObjectParameters

Clears the multimap.

close() - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Closes the writer.

close() - Method in class com.github.mangstadt.vinnie.io.VObjectReader

Closes the underlying input stream.

close() - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Closes the underlying output stream.

com.github.mangstadt.vinnie - package com.github.mangstadt.vinnie

Contains core, data model classes.

com.github.mangstadt.vinnie.io - package com.github.mangstadt.vinnie.io

Contains classes that can contain I/O functionality.

com.github.mangstadt.vinnie.validate - package com.github.mangstadt.vinnie.validate

Contains classes that can contain validation functionality.

Context - Class in com.github.mangstadt.vinnie.io

Contains information related to the status of a parse operation, such as the parent component hierarchy and line number.

E

equals(Object) - Method in class com.github.mangstadt.vinnie.VObjectParameters

equals(Object) - Method in class com.github.mangstadt.vinnie.VObjectProperty

escape(String) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Escapes all special characters within a property value.

escapeNewlines(String) - Static method in class com.github.mangstadt.vinnie.Utils

Escapes all newline sequences in a string with "\n".

except(String) - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Reject all the characters in the given string.

except(char) - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Reject the given character.

F

first(String) - Method in class com.github.mangstadt.vinnie.VObjectParameters

Gets the first value assigned to the given key.

flip() - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters

Returns an allowed character list that is the opposite of this allowed character list (in other words, characters that are NOT allowed).

flush() - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Flushes the writer.

flush() - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Flushes the underlying output stream.

FoldedLineWriter - Class in com.github.mangstadt.vinnie.io

Automatically folds lines as they are written.

FoldedLineWriter(Writer) - Constructor for class com.github.mangstadt.vinnie.io.FoldedLineWriter

Creates a folded line writer.

G

get(String) - Method in class com.github.mangstadt.vinnie.VObjectParameters

Gets the values that are assigned to a key.

getCharset() - Method in class com.github.mangstadt.vinnie.VObjectParameters

Gets the CHARSET parameter.

getDefaultQuotedPrintableCharset() - Method in class com.github.mangstadt.vinnie.io.VObjectReader

Gets the default character set to use when decoding quoted-printable values of properties that lack CHARSET parameters, or of properties whose CHARSET parameters are not recognized by the local JVM.

getDefaultSyntaxStyle() - Method in class com.github.mangstadt.vinnie.io.SyntaxRules

Gets the the syntax style to use when it can't be determined what the data stream uses.

getFoldedLineWriter() - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Gets the writer that is used to write data to the output stream.

getGroup() - Method in class com.github.mangstadt.vinnie.VObjectProperty

Gets the group name (note: iCalendar properties do not use group names).

getIndent() - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Gets the string that is prepended to each folded line (defaults to a single space character).

getLineLength() - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Gets the maximum length a line can be before it is folded (excluding the newline, defaults to 75).

getLineNumber() - Method in class com.github.mangstadt.vinnie.io.Context

Gets the line number of the parsed line.

getMap() - Method in class com.github.mangstadt.vinnie.VObjectParameters

Gets the map that backs this parameters list.

getMessage() - Method in enum com.github.mangstadt.vinnie.io.Warning

Gets a message describing the warning.

getName() - Method in class com.github.mangstadt.vinnie.VObjectProperty

Gets the property name.

getParameters() - Method in class com.github.mangstadt.vinnie.VObjectProperty

Gets the parameters.

getParentComponents() - Method in class com.github.mangstadt.vinnie.io.Context

Gets the hierarchy of parent components the parser is currently inside of, starting with the outer-most component.

getSyntaxStyle(String, String) - Method in class com.github.mangstadt.vinnie.io.SyntaxRules

Gets the syntax style to use for a given component.

getSyntaxStyle() - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Gets the syntax style the writer is using.

getUnfoldedLine() - Method in class com.github.mangstadt.vinnie.io.Context

Gets the raw, unfolded line that was parsed.

getValue() - Method in class com.github.mangstadt.vinnie.VObjectProperty

Gets the property value.

getWriter() - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Gets the wrapped Writer object.

H

hashCode() - Method in class com.github.mangstadt.vinnie.VObjectParameters

hashCode() - Method in class com.github.mangstadt.vinnie.VObjectProperty

hasNext() - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.SemiStructuredValueIterator

Determines if there are any more values left.

hasNext() - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueIterator

hasSyntaxRules(String) - Method in class com.github.mangstadt.vinnie.io.SyntaxRules

Determines if this object contains rules for the given component.

I

iCalendar() - Static method in class com.github.mangstadt.vinnie.io.SyntaxRules

Creates a set of rules for iCalendar data.

isCaretDecodingEnabled() - Method in class com.github.mangstadt.vinnie.io.VObjectReader

Gets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default).

isCaretEncodingEnabled() - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Gets whether the writer will apply circumflex accent encoding on parameter values (disabled by default).

isNonAsciiAllowed() - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters

Determines if this allowed character list permits characters that are not part of 7-bit ASCII (character codes greater than 127).

isQuotedPrintable() - Method in class com.github.mangstadt.vinnie.VObjectParameters

Determines if a "quoted-printable encoding" parameter exists.

iterator() - Method in class com.github.mangstadt.vinnie.VObjectParameters

Creates an iterator over all the parameters (for use in foreach loops).

L

ltrim(String) - Static method in class com.github.mangstadt.vinnie.Utils

Trims the whitespace off the left side of a string.

N

next() - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.SemiStructuredValueIterator

Gets the next value.

nextComponent() - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueIterator

Gets the next component.

nextValue() - Method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueIterator

Gets the first value of the next component.

O

onComponentBegin(String, Context) - Method in class com.github.mangstadt.vinnie.io.VObjectDataAdapter

onComponentBegin(String, Context) - Method in interface com.github.mangstadt.vinnie.io.VObjectDataListener

Called when a component begins (in other words, when a BEGIN property is encountered).

onComponentEnd(String, Context) - Method in class com.github.mangstadt.vinnie.io.VObjectDataAdapter

onComponentEnd(String, Context) - Method in interface com.github.mangstadt.vinnie.io.VObjectDataListener

Called when a component ends (in other words, when an END property is encountered).

onProperty(VObjectProperty, Context) - Method in class com.github.mangstadt.vinnie.io.VObjectDataAdapter

onProperty(VObjectProperty, Context) - Method in interface com.github.mangstadt.vinnie.io.VObjectDataListener

Called when a property is read.

onVersion(String, Context) - Method in class com.github.mangstadt.vinnie.io.VObjectDataAdapter

onVersion(String, Context) - Method in interface com.github.mangstadt.vinnie.io.VObjectDataListener

Called when a VERSION property is read whose value and position (as defined in SyntaxRules) are recognized as valid.

onWarning(Warning, VObjectProperty, Exception, Context) - Method in class com.github.mangstadt.vinnie.io.VObjectDataAdapter

onWarning(Warning, VObjectProperty, Exception, Context) - Method in interface com.github.mangstadt.vinnie.io.VObjectDataListener

Called when a non-fatal error occurs during parsing.

P

parse(VObjectDataListener) - Method in class com.github.mangstadt.vinnie.io.VObjectReader

Starts or continues to parse the data off the input stream.

parseList(String) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Parses a "list" property value.

parseMultimap(String) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Parses a "multimap" property value.

parseSemiStructured(String) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Parses a "semi-structured" property value.

parseSemiStructured(String, int) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Parses a "semi-structured" property value.

parseStructured(String) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Parses a "structured" property value.

put(String, String) - Method in class com.github.mangstadt.vinnie.VObjectParameters

Inserts a value.

putAll(String, String...) - Method in class com.github.mangstadt.vinnie.VObjectParameters

Inserts multiple values.

R

remove(String, String) - Method in class com.github.mangstadt.vinnie.VObjectParameters

Removes a value.

removeAll(String) - Method in class com.github.mangstadt.vinnie.VObjectParameters

Removes all values associated with a key, along with the key itself.

replace(String, String) - Method in class com.github.mangstadt.vinnie.VObjectParameters

Replaces all the values of the given key with the given value.

replaceAll(String, String...) - Method in class com.github.mangstadt.vinnie.VObjectParameters

Replaces all the values of the given key with the given values.

rtrim(String) - Static method in class com.github.mangstadt.vinnie.Utils

Trims the whitespace off the right side of a string.

S

SemiStructuredValueBuilder() - Constructor for class com.github.mangstadt.vinnie.io.VObjectPropertyValues.SemiStructuredValueBuilder

SemiStructuredValueIterator(String) - Constructor for class com.github.mangstadt.vinnie.io.VObjectPropertyValues.SemiStructuredValueIterator

Constructs a new semi-structured value iterator.

SemiStructuredValueIterator(String, int) - Constructor for class com.github.mangstadt.vinnie.io.VObjectPropertyValues.SemiStructuredValueIterator

Constructs a new semi-structured value iterator.

setCaretDecodingEnabled(boolean) - Method in class com.github.mangstadt.vinnie.io.VObjectReader

Sets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default).

setCaretEncodingEnabled(boolean) - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Sets whether the writer will apply circumflex accent encoding on parameter values (disabled by default).

setDefaultQuotedPrintableCharset(Charset) - Method in class com.github.mangstadt.vinnie.io.VObjectReader

Sets the character set to use when decoding quoted-printable values of properties that lack CHARSET parameters, or of properties whose CHARSET parameters are not recognized by the local JVM.

setDefaultSyntaxStyle(SyntaxStyle) - Method in class com.github.mangstadt.vinnie.io.SyntaxRules

Sets the syntax style to use when it can't be determined what the data stream uses.

setGroup(String) - Method in class com.github.mangstadt.vinnie.VObjectProperty

Sets the group name (note: iCalendar properties do not use group names).

setIndent(String) - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Sets the string that is prepended to each folded line (defaults to a single space character).

setLineLength(Integer) - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Sets the maximum length a line can be before it is folded (excluding the newline, defaults to 75).

setName(String) - Method in class com.github.mangstadt.vinnie.VObjectProperty

Sets the property name.

setParameters(VObjectParameters) - Method in class com.github.mangstadt.vinnie.VObjectProperty

Sets the parameters.

setSyntaxStyle(SyntaxStyle) - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Sets the syntax style that the writer should use.

setValue(String) - Method in class com.github.mangstadt.vinnie.VObjectProperty

Sets the property value.

stop() - Method in class com.github.mangstadt.vinnie.io.Context

Instructs the parser to stop parsing and return from the call to VObjectReader.parse(com.github.mangstadt.vinnie.io.VObjectDataListener).

StructuredValueBuilder() - Constructor for class com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueBuilder

StructuredValueIterator(String) - Constructor for class com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueIterator

Constructs a new structured value iterator.

StructuredValueIterator(List<List<String>>) - Constructor for class com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueIterator

Constructs a new structured value iterator.

SyntaxRules - Class in com.github.mangstadt.vinnie.io

Defines a set of rules that determine what kind of syntax the vobject data stream uses.

SyntaxRules(SyntaxStyle) - Constructor for class com.github.mangstadt.vinnie.io.SyntaxRules

Creates a new set of syntax rules.

SyntaxStyle - Enum in com.github.mangstadt.vinnie

Defines the various syntax styles a vobject data stream can have.

T

toString() - Method in class com.github.mangstadt.vinnie.io.Context

toString() - Method in enum com.github.mangstadt.vinnie.io.Warning

toString() - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters

Generates a string representation of this allowed character list.

toString(boolean) - Method in class com.github.mangstadt.vinnie.validate.AllowedCharacters

Generates a string representation of this allowed character list.

toString() - Method in class com.github.mangstadt.vinnie.VObjectParameters

toString() - Method in class com.github.mangstadt.vinnie.VObjectProperty

U

unescape(String) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Unescapes all escaped characters in a property value.

Utils - Class in com.github.mangstadt.vinnie

Contains miscellaneous utility methods.

V

validateGroupName(String, SyntaxStyle, boolean) - Static method in class com.github.mangstadt.vinnie.validate.VObjectValidator

Validates a group name.

validateParameterName(String, SyntaxStyle, boolean) - Static method in class com.github.mangstadt.vinnie.validate.VObjectValidator

Validates a parameter name.

validateParameterValue(String, SyntaxStyle, boolean, boolean) - Static method in class com.github.mangstadt.vinnie.validate.VObjectValidator

Validates a parameter value.

validatePropertyName(String, SyntaxStyle, boolean) - Static method in class com.github.mangstadt.vinnie.validate.VObjectValidator

Validates a property name.

valueOf(String) - Static method in enum com.github.mangstadt.vinnie.io.Warning

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.mangstadt.vinnie.SyntaxStyle

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.mangstadt.vinnie.io.Warning

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.mangstadt.vinnie.SyntaxStyle

Returns an array containing the constants of this enum type, in the order they are declared.

vcard() - Static method in class com.github.mangstadt.vinnie.io.SyntaxRules

Creates a set of rules for vCard data.

VObjectDataAdapter - Class in com.github.mangstadt.vinnie.io

Empty implementation of VObjectDataListener.

VObjectDataAdapter() - Constructor for class com.github.mangstadt.vinnie.io.VObjectDataAdapter

VObjectDataListener - Interface in com.github.mangstadt.vinnie.io

Callback interface used by VObjectReader for handling data as it is parsed off the data stream.

VObjectParameters - Class in com.github.mangstadt.vinnie

A simple multimap implementation for holding the parameters of a VObjectProperty.

VObjectParameters() - Constructor for class com.github.mangstadt.vinnie.VObjectParameters

Creates an empty list of parameters.

VObjectParameters(Map<String, List<String>>) - Constructor for class com.github.mangstadt.vinnie.VObjectParameters

Creates a list of parameters backed by the given map.

VObjectParameters(VObjectParameters) - Constructor for class com.github.mangstadt.vinnie.VObjectParameters

Copies an existing list of parameters.

VObjectProperty - Class in com.github.mangstadt.vinnie

Represents a vobject property.

VObjectProperty() - Constructor for class com.github.mangstadt.vinnie.VObjectProperty

Creates an empty property.

VObjectProperty(String, String) - Constructor for class com.github.mangstadt.vinnie.VObjectProperty

Create a new property.

VObjectProperty(String, String, String) - Constructor for class com.github.mangstadt.vinnie.VObjectProperty

Creates a new property

VObjectProperty(String, String, VObjectParameters, String) - Constructor for class com.github.mangstadt.vinnie.VObjectProperty

Creates a new property

VObjectPropertyValues - Class in com.github.mangstadt.vinnie.io

Contains utility methods for parsing and writing property values.

VObjectPropertyValues.SemiStructuredValueBuilder - Class in com.github.mangstadt.vinnie.io

Helper class for building "semi-structured" property values.

VObjectPropertyValues.SemiStructuredValueIterator - Class in com.github.mangstadt.vinnie.io

Helper class for iterating over the values in a "semi-structured" property value.

VObjectPropertyValues.StructuredValueBuilder - Class in com.github.mangstadt.vinnie.io

Helper class for building "structured" property values.

VObjectPropertyValues.StructuredValueIterator - Class in com.github.mangstadt.vinnie.io

Helper class for iterating over the values in a "structured" property value.

VObjectReader - Class in com.github.mangstadt.vinnie.io

Parses a vobject data stream.

VObjectReader(Reader, SyntaxRules) - Constructor for class com.github.mangstadt.vinnie.io.VObjectReader

Creates a new vobject reader.

VObjectValidator - Class in com.github.mangstadt.vinnie.validate

Checks properties for illegal characters.

VObjectWriter - Class in com.github.mangstadt.vinnie.io

Writes data to a vobject data stream.

VObjectWriter(Writer, SyntaxStyle) - Constructor for class com.github.mangstadt.vinnie.io.VObjectWriter

Creates a new vobject writer.

W

Warning - Enum in com.github.mangstadt.vinnie.io

Lists the non-fatal problems that can occur when parsing a vobject data stream.

write(CharSequence, boolean, Charset) - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Writes a string.

write(char[], int, int) - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Writes a portion of an array of characters.

write(char[], int, int, boolean, Charset) - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Writes a portion of an array of characters.

writeBeginComponent(String) - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Writes a property marking the beginning of a component.

writeEndComponent(String) - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Writes a property marking the end of a component.

writeList(Collection<?>) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Generates a "list" property value.

writeln() - Method in class com.github.mangstadt.vinnie.io.FoldedLineWriter

Writes a newline.

writeMultimap(Map<String, ? extends List<?>>) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Writes a "multimap" property value.

writeProperty(String, String) - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Writes a property to the data stream.

writeProperty(VObjectProperty) - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Writes a property to the data stream.

writeProperty(String, String, VObjectParameters, String) - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Writes a property to the data stream.

writeSemiStructured(List<?>, boolean, boolean) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Writes a "semi-structured" property value.

writeStructured(List<? extends List<?>>, boolean) - Static method in class com.github.mangstadt.vinnie.io.VObjectPropertyValues

Writes a "structured" property value.

writeVersion(String) - Method in class com.github.mangstadt.vinnie.io.VObjectWriter

Writes a "VERSION" property.

A B C E F G H I L N O P R S T U V W