View Javadoc
1   /*
2    * Copyright 2014 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.handler.codec.stomp;
17  
18  import io.netty.handler.codec.AsciiString;
19  import io.netty.handler.codec.TextHeaders;
20  
21  /**
22   * The multimap data structure for the STOMP header names and values. It also provides the constants for the standard
23   * STOMP header names and values.
24   */
25  public interface StompHeaders extends TextHeaders {
26  
27      AsciiString ACCEPT_VERSION = new AsciiString("accept-version");
28      AsciiString HOST = new AsciiString("host");
29      AsciiString LOGIN = new AsciiString("login");
30      AsciiString PASSCODE = new AsciiString("passcode");
31      AsciiString HEART_BEAT = new AsciiString("heart-beat");
32      AsciiString VERSION = new AsciiString("version");
33      AsciiString SESSION = new AsciiString("session");
34      AsciiString SERVER = new AsciiString("server");
35      AsciiString DESTINATION = new AsciiString("destination");
36      AsciiString ID = new AsciiString("id");
37      AsciiString ACK = new AsciiString("ack");
38      AsciiString TRANSACTION = new AsciiString("transaction");
39      AsciiString RECEIPT = new AsciiString("receipt");
40      AsciiString MESSAGE_ID = new AsciiString("message-id");
41      AsciiString SUBSCRIPTION = new AsciiString("subscription");
42      AsciiString RECEIPT_ID = new AsciiString("receipt-id");
43      AsciiString MESSAGE = new AsciiString("message");
44      AsciiString CONTENT_LENGTH = new AsciiString("content-length");
45      AsciiString CONTENT_TYPE = new AsciiString("content-type");
46  
47      @Override
48      StompHeaders add(CharSequence name, CharSequence value);
49  
50      @Override
51      StompHeaders add(CharSequence name, Iterable<? extends CharSequence> values);
52  
53      @Override
54      StompHeaders add(CharSequence name, CharSequence... values);
55  
56      @Override
57      StompHeaders addObject(CharSequence name, Object value);
58  
59      @Override
60      StompHeaders addObject(CharSequence name, Iterable<?> values);
61  
62      @Override
63      StompHeaders addObject(CharSequence name, Object... values);
64  
65      @Override
66      StompHeaders addBoolean(CharSequence name, boolean value);
67  
68      @Override
69      StompHeaders addByte(CharSequence name, byte value);
70  
71      @Override
72      StompHeaders addChar(CharSequence name, char value);
73  
74      @Override
75      StompHeaders addShort(CharSequence name, short value);
76  
77      @Override
78      StompHeaders addInt(CharSequence name, int value);
79  
80      @Override
81      StompHeaders addLong(CharSequence name, long value);
82  
83      @Override
84      StompHeaders addFloat(CharSequence name, float value);
85  
86      @Override
87      StompHeaders addDouble(CharSequence name, double value);
88  
89      @Override
90      StompHeaders addTimeMillis(CharSequence name, long value);
91  
92      @Override
93      StompHeaders add(TextHeaders headers);
94  
95      @Override
96      StompHeaders set(CharSequence name, CharSequence value);
97  
98      @Override
99      StompHeaders set(CharSequence name, Iterable<? extends CharSequence> values);
100 
101     @Override
102     StompHeaders set(CharSequence name, CharSequence... values);
103 
104     @Override
105     StompHeaders setObject(CharSequence name, Object value);
106 
107     @Override
108     StompHeaders setObject(CharSequence name, Iterable<?> values);
109 
110     @Override
111     StompHeaders setObject(CharSequence name, Object... values);
112 
113     @Override
114     StompHeaders setBoolean(CharSequence name, boolean value);
115 
116     @Override
117     StompHeaders setByte(CharSequence name, byte value);
118 
119     @Override
120     StompHeaders setChar(CharSequence name, char value);
121 
122     @Override
123     StompHeaders setShort(CharSequence name, short value);
124 
125     @Override
126     StompHeaders setInt(CharSequence name, int value);
127 
128     @Override
129     StompHeaders setLong(CharSequence name, long value);
130 
131     @Override
132     StompHeaders setFloat(CharSequence name, float value);
133 
134     @Override
135     StompHeaders setDouble(CharSequence name, double value);
136 
137     @Override
138     StompHeaders setTimeMillis(CharSequence name, long value);
139 
140     @Override
141     StompHeaders set(TextHeaders headers);
142 
143     @Override
144     StompHeaders setAll(TextHeaders headers);
145 
146     @Override
147     StompHeaders clear();
148 }