Package | Description |
---|---|
ezvcard | |
ezvcard.io |
Contains I/O related classes.
|
ezvcard.io.chain |
Contains classes used in the chaining API.
|
ezvcard.io.json |
Contains classes that can read/write jCards (JSON-encoded vCards).
|
ezvcard.io.scribe |
Contains classes that know how to marshal and unmarshal a property in each vCard format.
|
ezvcard.io.text |
Contains classes that can read/write traditional, plain-text vCards.
|
ezvcard.io.xml |
Contains classes that can read/write xCards (XML-encoded vCards).
|
ezvcard.parameter |
Contains classes related to vCard parameters.
|
ezvcard.property |
Contains the DTO class for each property.
|
Modifier and Type | Method and Description |
---|---|
VCardVersion[] |
VCardDataType.getSupportedVersions()
Gets the vCard versions that support this data type.
|
VCardVersion |
VCard.getVersion()
Gets the version attached to this vCard.
|
static VCardVersion |
VCardVersion.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static VCardVersion |
VCardVersion.valueOfByStr(String value)
Gets a
VCardVersion instance based on the given text
representation. |
static VCardVersion |
VCardVersion.valueOfByXmlNamespace(String ns)
Gets a
VCardVersion instance based on the given XML namespace. |
static VCardVersion[] |
VCardVersion.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
Modifier and Type | Method and Description |
---|---|
boolean |
VCardDataType.isSupportedBy(VCardVersion version)
Determines if this data type is supported by the given vCard version.
|
void |
VCard.setVersion(VCardVersion version)
Sets the version of this vCard.
|
ValidationWarnings |
VCard.validate(VCardVersion version)
Checks this vCard for data consistency problems or deviations from the
spec.
|
Constructor and Description |
---|
VCard(VCardVersion version)
Creates a new vCard.
|
Modifier and Type | Method and Description |
---|---|
protected abstract VCardVersion |
StreamWriter.getTargetVersion()
Gets the version that the next vCard will be written as.
|
VCardVersion |
ParseContext.getVersion()
Gets the version of the vCard being parsed.
|
Modifier and Type | Method and Description |
---|---|
void |
ParseContext.setVersion(VCardVersion version)
Sets the version of the vCard being parsed.
|
Modifier and Type | Method and Description |
---|---|
ChainingTextWriter |
ChainingTextWriter.version(VCardVersion version)
Sets the version that all the vCards will be marshalled to.
|
Modifier and Type | Method and Description |
---|---|
protected VCardVersion |
JCardWriter.getTargetVersion() |
Modifier and Type | Method and Description |
---|---|
protected VCardDataType |
AgentScribe._dataType(Agent property,
VCardVersion version) |
protected VCardDataType |
KeyScribe._dataType(Key property,
VCardVersion version) |
protected VCardDataType |
RawPropertyScribe._dataType(RawProperty property,
VCardVersion version) |
protected VCardDataType |
RelatedScribe._dataType(Related property,
VCardVersion version) |
protected VCardDataType |
TelephoneScribe._dataType(Telephone property,
VCardVersion version) |
protected VCardDataType |
TimezoneScribe._dataType(Timezone property,
VCardVersion version) |
protected VCardDataType |
VCardPropertyScribe._dataType(T property,
VCardVersion version)
Determines the data type of a property instance.
|
protected VCardDataType |
PlacePropertyScribe._dataType(T property,
VCardVersion version) |
protected VCardDataType |
DateOrTimePropertyScribe._dataType(T property,
VCardVersion version) |
protected VCardDataType |
BinaryPropertyScribe._dataType(T property,
VCardVersion version) |
protected VCardDataType |
XmlScribe._defaultDataType(VCardVersion version) |
protected abstract VCardDataType |
VCardPropertyScribe._defaultDataType(VCardVersion version)
Determines the property's default data type.
|
protected VCardDataType |
TimezoneScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
TelephoneScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
StructuredNameScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
SimplePropertyScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
RevisionScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
RelatedScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
RawPropertyScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
PlacePropertyScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
OrganizationScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
ListPropertyScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
ImppScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
GeoScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
GenderScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
DateOrTimePropertyScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
ClientPidMapScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
BinaryPropertyScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
AgentScribe._defaultDataType(VCardVersion version) |
protected VCardDataType |
AddressScribe._defaultDataType(VCardVersion version) |
protected void |
AddressScribe._prepareParameters(Address property,
VCardParameters copy,
VCardVersion version,
VCard vcard) |
protected void |
EmailScribe._prepareParameters(Email property,
VCardParameters copy,
VCardVersion version,
VCard vcard) |
protected void |
ImppScribe._prepareParameters(Impp property,
VCardParameters copy,
VCardVersion version,
VCard vcard) |
protected void |
KeyScribe._prepareParameters(Key property,
VCardParameters copy,
VCardVersion version,
VCard vcard) |
protected void |
TelephoneScribe._prepareParameters(Telephone property,
VCardParameters copy,
VCardVersion version,
VCard vcard) |
protected void |
VCardPropertyScribe._prepareParameters(T property,
VCardParameters copy,
VCardVersion version,
VCard vcard)
Sanitizes a property's parameters before the property is written.
|
protected void |
BinaryPropertyScribe._prepareParameters(T property,
VCardParameters copy,
VCardVersion version,
VCard vcard) |
protected Key |
KeyScribe.cannotUnmarshalValue(String value,
VCardVersion version,
KeyType contentType) |
protected T |
BinaryPropertyScribe.cannotUnmarshalValue(String value,
VCardVersion version,
U contentType)
Called if the unmarshalling code cannot determine how to unmarshal the
value.
|
VCardDataType |
VCardPropertyScribe.dataType(T property,
VCardVersion version)
Determines the data type of a property instance.
|
VCardDataType |
VCardPropertyScribe.defaultDataType(VCardVersion version)
Determines the property's default data type.
|
protected static void |
VCardPropertyScribe.handlePrefParam(VCardProperty property,
VCardParameters parameters,
VCardVersion version,
VCard vcard)
A utility method for switching between the "PREF" and "TYPE=PREF"
parameters when marshalling a property (version 4.0 vCards use "PREF=1",
while version 3.0 vCards use "TYPE=PREF").
|
protected T |
BinaryPropertyScribe.parse(String value,
VCardDataType dataType,
VCardParameters parameters,
VCardVersion version)
Parses the property.
|
protected U |
BinaryPropertyScribe.parseContentTypeFromParameters(VCardParameters parameters,
VCardVersion version)
Tries to determine a property value's content type by looking at the
property's parameters.
|
protected U |
BinaryPropertyScribe.parseContentTypeFromValueAndParameters(String value,
VCardParameters parameters,
VCardVersion version)
Tries to determine a property value's content type by looking at the
property's parameters and value.
|
VCardParameters |
VCardPropertyScribe.prepareParameters(T property,
VCardVersion version,
VCard vcard)
Sanitizes a property's parameters (called before the property is
written).
|
Modifier and Type | Method and Description |
---|---|
VCardVersion |
VCardWriter.getTargetVersion()
Gets the version that the vCards should adhere to.
|
VCardVersion |
WriteContext.getVersion()
Gets the version that the vCard should adhere to.
|
Modifier and Type | Method and Description |
---|---|
void |
VCardWriter.setTargetVersion(VCardVersion targetVersion)
Sets the version that the vCards should adhere to.
|
Constructor and Description |
---|
VCardReader(InputStream in,
VCardVersion defaultVersion)
Creates a new vCard reader.
|
VCardReader(Path file,
VCardVersion defaultVersion)
Creates a new vCard reader.
|
VCardReader(Reader reader,
VCardVersion defaultVersion)
Creates a new vCard reader.
|
VCardReader(String str,
VCardVersion defaultVersion)
Creates a new vCard reader.
|
VCardWriter(OutputStream out,
VCardVersion targetVersion) |
VCardWriter(Path file,
boolean append,
VCardVersion targetVersion) |
VCardWriter(Path file,
VCardVersion targetVersion) |
VCardWriter(Writer writer,
VCardVersion targetVersion) |
WriteContext(VCardVersion version,
TargetApplication targetApplication,
boolean includeTrailingSemicolons) |
Modifier and Type | Method and Description |
---|---|
VCardVersion |
XCardElement.version()
Gets the vCard version.
|
Constructor and Description |
---|
XCardElement(Element element,
VCardVersion version)
Wraps an existing XML element.
|
XCardNamespaceContext(VCardVersion version,
String prefix) |
Modifier and Type | Method and Description |
---|---|
VCardVersion[] |
VCardParameter.getSupportedVersions()
Gets the vCard versions that support this parameter value.
|
Modifier and Type | Method and Description |
---|---|
boolean |
VCardParameter.isSupportedBy(VCardVersion version)
Determines if this parameter value is supported by the given vCard
version.
|
List<ValidationWarning> |
VCardParameters.validate(VCardVersion version)
Checks the parameters for data consistency problems or deviations from
the specification.
|
Modifier and Type | Method and Description |
---|---|
VCardVersion[] |
VCardProperty.getSupportedVersions()
Gets the vCard versions that support this property.
|
Modifier and Type | Method and Description |
---|---|
protected void |
Xml._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
VCardProperty._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard)
Checks the property for data consistency problems or deviations from the
spec.
|
protected void |
Timezone._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Telephone._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
StructuredName._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
SimpleProperty._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Related._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
RawProperty._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Profile._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
PlaceProperty._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Member._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
ListProperty._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Key._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Impp._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Geo._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Gender._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Email._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
DateOrTimeProperty._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
ClientPidMap._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
BinaryProperty._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Agent._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
protected void |
Address._validate(List<ValidationWarning> warnings,
VCardVersion version,
VCard vcard) |
boolean |
VCardProperty.isSupportedBy(VCardVersion version)
Determines if this property is supported by the given vCard version.
|
List<ValidationWarning> |
VCardProperty.validate(VCardVersion version,
VCard vcard)
Checks the property for data consistency problems or deviations from the
spec.
|
Copyright © 2012–2023 Michael Angstadt. All rights reserved.