org.jSyncManager.API.Conduit.Tools.vTypes.vEntity
Class vName

java.lang.Object
  org.jSyncManager.API.Protocol.Util.DLPRecord
      org.jSyncManager.API.Conduit.Tools.vTypes.vCommon.vObject
          org.jSyncManager.API.Conduit.Tools.vTypes.vCommon.vProperty
              org.jSyncManager.API.Conduit.Tools.vTypes.vEntity.vName

All Implemented Interfaces:

java.io.Serializable

public class vName

extends vProperty

vCard Name specification implementation for the AddressRecord API class.

Version:

$Revision: 1.3 $

Author:

David A. Bartmess <dingodave@edingo.net>
Last modified by: $Author: dingodave $ on $Date: 2004/08/07 06:01:32 $.

See Also:

AddressRecord, Serialized Form

Field Summary

Fields inherited from class org.jSyncManager.API.Conduit.Tools.vTypes.vCommon.vObject

BEGIN, CRLF, END, properties

Fields inherited from class org.jSyncManager.API.Protocol.Util.DLPRecord

ARCHIVED, attributes, BUSY, category, data, DATA_INCLUDED, DELETE_ALL_IN_CATEGORY, DELETE_ALL_RECORDS, DELETED, DIRTY, index, inputData, recordID, recordSize, SECRET, SORT_DATABASE

Constructor Summary

vName()
Creates a new instance of vName

vName(AddressRecord rec)

vName(vFoldedFile file, java.lang.Integer lineno)

vName(vName newname)

Method Summary

java.lang.String	format() Formats the object in .vcs format, according to the RFC 2445.
java.lang.String	getFormattedName() Getter for property formattedName.
java.lang.String	getGivenName() Getter for property givenName.
java.lang.String	getMiddleName() Getter for property middleName.
java.lang.String	getPrefix() Getter for property prefix.
AddressRecord	getRecord(AddressRecord rec)
java.lang.String	getSuffix() Getter for property suffix.
java.lang.String	getSurname() Getter for property surname.
void	importRecord(AddressRecord rec)
protected void	parse(vFoldedFile file, int lineno) Parses a String for property values and parameters.
void	setFormattedName(java.lang.String formattedName) Setter for property formattedName.
void	setGivenName(java.lang.String givenName) Setter for property givenName.
void	setMiddleName(java.lang.String middleName) Setter for property middleName.
void	setPrefix(java.lang.String prefix) Setter for property prefix.
void	setSuffix(java.lang.String suffix) Setter for property suffix.
void	setSurname(java.lang.String surname) Setter for property surname.
java.lang.String	toString() Returns a string containing the information in the object.

Methods inherited from class org.jSyncManager.API.Conduit.Tools.vTypes.vCommon.vProperty

addParam, addParam, equals, getName, getParam, getParams, getValue, setName, setParams, setParams, setValue

Methods inherited from class org.jSyncManager.API.Conduit.Tools.vTypes.vCommon.vObject

checkExclusive, checkMandatory, getGroup, getLineno, getProperties, getResources, getVObjectClass, importRecord, isSingleInstance, isStarted, parseName, setGroup, setLineno, setProperties, setResources, setStarted

Methods inherited from class org.jSyncManager.API.Protocol.Util.DLPRecord

addAttribute, checkAttribute, clearAttribute, generateData, getAttributes, getCategory, getData, getIndex, getRecordID, getRecordSize, parseFields, setAttributes, setCategory, setData, setIndex, setRecordID, setRecordSize

Methods inherited from class java.lang.Object

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

Constructor Detail

vName

public vName()
      throws java.text.ParseException

Creates a new instance of vName

vName

public vName(vFoldedFile file,
             java.lang.Integer lineno)
      throws java.text.ParseException,
             java.io.IOException

vName

public vName(vName newname)
      throws java.text.ParseException

vName

public vName(AddressRecord rec)
      throws java.text.ParseException

Method Detail

parse

protected void parse(vFoldedFile file,
                     int lineno)
              throws java.text.ParseException

Description copied from class: vProperty

Parses a String for property values and parameters.

Overrides:

parse in class vProperty

Parameters:

file - a vFoldedFile instance.

lineno - the line number to start the parse from.

Throws:

java.text.ParseException - in case of String parsing not containing valid content.

getFormattedName

public java.lang.String getFormattedName()

Getter for property formattedName.

Returns:

Value of property formattedName.

setFormattedName

public void setFormattedName(java.lang.String formattedName)

Setter for property formattedName.

Parameters:

formattedName - New value of property formattedName.

getGivenName

public java.lang.String getGivenName()

Getter for property givenName.

Returns:

Value of property givenName.

setGivenName

public void setGivenName(java.lang.String givenName)

Setter for property givenName.

Parameters:

givenName - New value of property givenName.

getMiddleName

public java.lang.String getMiddleName()

Getter for property middleName.

Returns:

Value of property middleName.

setMiddleName

public void setMiddleName(java.lang.String middleName)

Setter for property middleName.

Parameters:

middleName - New value of property middleName.

getPrefix

public java.lang.String getPrefix()

Getter for property prefix.

Returns:

Value of property prefix.

setPrefix

public void setPrefix(java.lang.String prefix)

Setter for property prefix.

Parameters:

prefix - New value of property prefix.

getSuffix

public java.lang.String getSuffix()

Getter for property suffix.

Returns:

Value of property suffix.

setSuffix

public void setSuffix(java.lang.String suffix)

Setter for property suffix.

Parameters:

suffix - New value of property suffix.

getSurname

public java.lang.String getSurname()

Getter for property surname.

Returns:

Value of property surname.

setSurname

public void setSurname(java.lang.String surname)

Setter for property surname.

Parameters:

surname - New value of property surname.

format

public java.lang.String format()

Description copied from class: vProperty

Formats the object in .vcs format, according to the RFC 2445. See the specification at http://www.ietf.org/rfc/rfc2445.txt

Overrides:

format in class vProperty

Returns:

RFC2445 specification-formatted String.

toString

public java.lang.String toString()

Description copied from class: vProperty

Returns a string containing the information in the object.

Overrides:

toString in class vProperty

Returns:

String value of vProperty class.

getRecord

public AddressRecord getRecord(AddressRecord rec)

importRecord

public void importRecord(AddressRecord rec)