01: /**
02: * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
03: * Unpublished - rights reserved under the Copyright Laws of the United States.
04: * Copyright © 2003 Sun Microsystems, Inc. All rights reserved.
05: * Copyright © 2005 BEA Systems, Inc. All rights reserved.
06: *
07: * Use is subject to license terms.
08: *
09: * This distribution may include materials developed by third parties.
10: *
11: * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12: *
13: * Module Name : JSIP Specification
14: * File Name : OptionTag.java
15: * Author : Phelim O'Doherty
16: *
17: * HISTORY
18: * Version Date Author Comments
19: * 1.1 08/10/2002 Phelim O'Doherty Initial version
20: *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21: */package javax.sip.header;
22:
23: import java.text.ParseException;
24:
25: /**
26: * This interface represents methods for manipulating OptionTags
27: * values for any header that contains an OptionTag value. Option tags are
28: * unique identifiers used to designate new options (extensions) in SIP. Note
29: * that these options appear as parameters in those header fields in an
30: * option-tag = token form. Option tags are defined in standards track RFCs.
31: * This is a change from past practice, and is instituted to ensure continuing
32: * multi-vendor interoperability.
33: *
34: * @see ProxyRequireHeader
35: * @see RequireHeader
36: * @see UnsupportedHeader
37: * @see SupportedHeader
38: *
39: * @author BEA Systems, NIST
40: * @version 1.2
41: */
42:
43: public interface OptionTag {
44:
45: /**
46: * Sets the option tag value to the new supplied optionTag
47: * parameter.
48: *
49: * @param optionTag - the new string value of the option tag.
50: * @throws ParseException which signals that an error has been reached
51: * unexpectedly while parsing the optionTag value.
52: */
53: public void setOptionTag(String optionTag) throws ParseException;
54:
55: /**
56: * Gets the option tag of this OptionTag class.
57: *
58: * @return the string that identifies the option tag value.
59: */
60: public String getOptionTag();
61:
62: }
|