01: /*
02: * Portions Copyright 2000-2007 Sun Microsystems, Inc. All Rights
03: * Reserved. Use is subject to license terms.
04: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
05: *
06: * This program is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU General Public License version
08: * 2 only, as published by the Free Software Foundation.
09: *
10: * This program is distributed in the hope that it will be useful, but
11: * WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * General Public License version 2 for more details (a copy is
14: * included at /legal/license.txt).
15: *
16: * You should have received a copy of the GNU General Public License
17: * version 2 along with this work; if not, write to the Free Software
18: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
19: * 02110-1301 USA
20: *
21: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
22: * Clara, CA 95054 or visit www.sun.com if you need additional
23: * information or have any questions.
24: */
25: /*
26: */
27: package gov.nist.javax.sdp.fields;
28:
29: /**
30: * Placeholder root class for SDP headers.
31: *
32: * @version JAIN-SIP-1.1
33: *
34: *
35: * <a href="{@docRoot}/uncopyright.html">This code is in the public domain.</a>
36: *
37: */
38:
39: public abstract class SDPField extends SDPObject {
40: /** Session Description Protocol field. */
41: protected String fieldName;
42:
43: /**
44: * Gets an encoded string representation of the instance.
45: * @return encoded string of object contents
46: */
47: public abstract String encode();
48:
49: /**
50: * Constructs a field with initial name.
51: * @param hname the field hname
52: */
53: protected SDPField(String hname) {
54: fieldName = hname;
55: }
56:
57: /**
58: * Gets the field name.
59: * @return the field name
60: */
61: public String getFieldName() {
62: return fieldName;
63: }
64:
65: /**
66: * Returns the type character for the field.
67: * @return the type character for the field.
68: */
69: public char getTypeChar() {
70: if (fieldName == null)
71: return '\0';
72: else
73: return fieldName.charAt(0);
74: }
75:
76: /** Default constructor. */
77: public SDPField() {
78: }
79:
80: /**
81: * Gets a user friendly textual represntation
82: * of the object contents.
83: * @return encoded string of object contents.
84: */
85: public String toString() {
86: return this.encode();
87: }
88:
89: }
|