001: /*
002: * Portions Copyright 2000-2007 Sun Microsystems, Inc. All Rights
003: * Reserved. Use is subject to license terms.
004: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
005: *
006: * This program is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU General Public License version
008: * 2 only, as published by the Free Software Foundation.
009: *
010: * This program is distributed in the hope that it will be useful, but
011: * WITHOUT ANY WARRANTY; without even the implied warranty of
012: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
013: * General Public License version 2 for more details (a copy is
014: * included at /legal/license.txt).
015: *
016: * You should have received a copy of the GNU General Public License
017: * version 2 along with this work; if not, write to the Free Software
018: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
019: * 02110-1301 USA
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
022: * Clara, CA 95054 or visit www.sun.com if you need additional
023: * information or have any questions.
024: */
025: /*
026: */
027: package gov.nist.javax.sdp.fields;
028:
029: import gov.nist.core.*;
030:
031: /**
032: * Email address field of the SDP header.
033: *
034: * @version JSR141-PUBLIC-REVIEW (subject to change)
035: *
036: *
037: * <a href="{@docRoot}/uncopyright.html">This code is in the public domain.</a>
038: *
039: */
040: public class EmailAddress extends SDPObject {
041: /** Current user friendly display name. */
042: protected String displayName;
043: /** Current email address */
044: protected Email email;
045:
046: /**
047: * Copies the current instance.
048: * @return the copy of this object
049: */
050: public Object clone() {
051: EmailAddress retval = new EmailAddress();
052: retval.displayName = displayName;
053: if (email != null)
054: retval.email = (Email) email.clone();
055: return retval;
056: }
057:
058: /**
059: * Gets the current user friendly name.
060: * @return the display name
061: */
062: public String getDisplayName() {
063: return displayName;
064: }
065:
066: /**
067: * Sets the display name member.
068: * @param displayName the new display name
069: */
070: public void setDisplayName(String displayName) {
071: this .displayName = displayName;
072: }
073:
074: /**
075: * Sets the email address member.
076: * @param email the new email address
077: */
078: public void setEmail(Email email) {
079: this .email = email;
080: }
081:
082: /**
083: * Gets the string encoded version of this object.
084: * Here, we implement only the "displayName <email>" form
085: * and not the "email (displayName)" form.
086: * @return the encoded string of this object contents
087: * @since v1.0
088: */
089: public String encode() {
090: String encoded_string;
091:
092: if (displayName != null) {
093: encoded_string = displayName + Separators.LESS_THAN;
094: } else {
095: encoded_string = "";
096: }
097: encoded_string += email.encode();
098: if (displayName != null) {
099: encoded_string += Separators.GREATER_THAN;
100: }
101: return encoded_string;
102: }
103:
104: }
|