Source code: com/voytechs/jnetstream/codec/Header.java
1 /*
2 * File: Header.java
3 * Auth: Mark Bednarczyk
4 * Date: 2003-06-27
5 * Id: $Id: Header.java,v 1.1.1.1 2003/09/22 16:32:13 voytechs Exp $
6 ********************************************
7 Copyright (C) 2003 Mark Bednarczyk
8
9 This program is free software; you can redistribute it and/or
10 modify it under the terms of the GNU General Public License
11 as published by the Free Software Foundation; either version 2
12 of the License, or (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 ********************************************
23 * $Log: Header.java,v $
24 * Revision 1.1.1.1 2003/09/22 16:32:13 voytechs
25 * Initial import.
26 *
27 */
28 package com.voytechs.jnetstream.codec;
29
30 import java.lang.*;
31 import java.util.*;
32
33 /**
34 * Protocol Header definition interface. This interface allows access to get various properties of
35 * a created run-time instance of header object. This object is created based on the HeaderFactory definition
36 * object which contains various global and instance specific parameters.
37 */
38 public interface Header
39 extends Identity {
40
41 /**
42 * Properties for a header.
43 */
44 public static final String NAME = "name"; // Name of the header
45 public static final String SUMMARY = "summary"; // 1 line summary line
46 public static final String COMMON = "common"; // Common name for this header
47
48 public static final String RFC = "rfc";
49 public static final String STD = "std";
50 public static final String IEEE = "ieee";
51 public static final String IMTC = "imtc";
52 public static final String ITU = "itu";
53 public static final String OMG = "omg";
54 public static final String W3C = "w3c";
55 public static final String IETF = "ietf";
56 public static final String ANSI = "ansi";
57 public static final String DOC = "doc";
58
59 public static final String OSILAYER = "osilayer";
60 public static final String DESCRIPTION = "description";
61 public static final String SHORTHEADER = "shortheader";
62 public static final String COMPANY = "company";
63 public static final String ORGANIZATION = "organization";
64 public static final String COPYRIGHT = "copyright";
65 public static final String TRADEMARK = "trademark";
66 public static final String SHORTDESCRIPTION = "shortdescription";
67 public static final String ABREVIATION = "abreviation";
68 public static final String HTTP = "http";
69 public static final String AUTHOR = "author";
70 public static final String CREATOR = "creator";
71 public static final String ADMINISTRATOR = "administrator";
72 public static final String CREATIONDATE = "creationdate";
73 public static final String ACL = "acl";
74
75 public static final String HIDEHEADERLINE = "hideheaderline";
76
77
78 public Field getField(String name);
79 public Field getField(int index);
80
81 public int getFieldCount();
82
83 /**
84 * Get the length of the header.
85 * @return length of the header in bytes.
86 */
87 public int getHeaderLength();
88
89 } /* END OF: Header */