com.github.mangstadt.vinnie.io

Class SyntaxRules

java.lang.Object

com.github.mangstadt.vinnie.io.SyntaxRules

public class SyntaxRules
extends Object

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

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
SyntaxRules(SyntaxStyle defaultSyntaxStyle) Creates a new set of syntax rules.

Method Summary

Modifier and Type	Method and Description
void	addRule(String component, String version, SyntaxStyle syntaxStyle) Adds a rule.
SyntaxStyle	getDefaultSyntaxStyle() Gets the the syntax style to use when it can't be determined what the data stream uses.
SyntaxStyle	getSyntaxStyle(String component, String versionValue) Gets the syntax style to use for a given component.
boolean	hasSyntaxRules(String component) Determines if this object contains rules for the given component.
static SyntaxRules	iCalendar() Creates a set of rules for iCalendar data.
void	setDefaultSyntaxStyle(SyntaxStyle defaultSyntaxStyle) Sets the syntax style to use when it can't be determined what the data stream uses.
static SyntaxRules	vcard() Creates a set of rules for vCard data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyntaxRules

public SyntaxRules(SyntaxStyle defaultSyntaxStyle)

Creates a new set of syntax rules.

Parameters:

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

Method Detail

getDefaultSyntaxStyle

public SyntaxStyle getDefaultSyntaxStyle()

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

Returns:

the default syntax style

setDefaultSyntaxStyle

public void setDefaultSyntaxStyle(SyntaxStyle defaultSyntaxStyle)

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

Parameters:

defaultSyntaxStyle - the default syntax style (cannot be null)

hasSyntaxRules

public boolean hasSyntaxRules(String component)

Determines if this object contains rules for the given component.

Parameters:

component - the component name (e.g. "VCARD")

Returns:

true if this component has syntax rules, false if not

getSyntaxStyle

public SyntaxStyle getSyntaxStyle(String component,
                                  String versionValue)

Gets the syntax style to use for a given component.

Parameters:

component - the component name (e.g. "VCARD")

versionValue - the value of the component's VERSION property (e.g. "2.1")

Returns:

the syntax style or null if none was found

addRule

public void addRule(String component,
                    String version,
                    SyntaxStyle syntaxStyle)

Adds a rule.

Parameters:

component - the name of the component that contains the VERSION property (e.g. "VCARD"), or null if the VERSION property will not be inside of any components

version - the value of the VERSION property

syntaxStyle - the syntax style to use when a VERSION property with the given value, and under the given component, is encountered

iCalendar

public static SyntaxRules iCalendar()

Creates a set of rules for iCalendar data.

Returns:

the rules

vcard

public static SyntaxRules vcard()

Creates a set of rules for vCard data.

Returns:

the rules