Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
HeaderFieldParser |
|
| 1.0;1 |
1 | /* Copyright © 2012, 2013 Matthew Champion | |
2 | All rights reserved. | |
3 | ||
4 | Redistribution and use in source and binary forms, with or without | |
5 | modification, are permitted provided that the following conditions are met: | |
6 | * Redistributions of source code must retain the above copyright | |
7 | notice, this list of conditions and the following disclaimer. | |
8 | * Redistributions in binary form must reproduce the above copyright | |
9 | notice, this list of conditions and the following disclaimer in the | |
10 | documentation and/or other materials provided with the distribution. | |
11 | * Neither the name of mattunderscore.com nor the | |
12 | names of its contributors may be used to endorse or promote products | |
13 | derived from this software without specific prior written permission. | |
14 | ||
15 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | |
16 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | |
17 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
18 | DISCLAIMED. IN NO EVENT SHALL MATTHEW CHAMPION BE LIABLE FOR ANY | |
19 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
20 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | |
21 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | |
22 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
23 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
24 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ | |
25 | ||
26 | package com.mattunderscore.http.headers; | |
27 | ||
28 | /** | |
29 | * Parser for the header field of an HTTP request. | |
30 | * <P> | |
31 | * Takes a type parameter that specifies the type of header field elements that returned by the | |
32 | * parser. | |
33 | * | |
34 | * @author Matt Champion | |
35 | * @param <T> | |
36 | * The header field that is being parsed. | |
37 | * @since 0.0.13 | |
38 | */ | |
39 | public interface HeaderFieldParser<T extends HeaderFieldElement> | |
40 | { | |
41 | /** | |
42 | * Parses a string for a single header field element. | |
43 | * | |
44 | * @param header | |
45 | * String of a header field element | |
46 | * @return The structured header field element | |
47 | * @throws UnParsableHeaderException | |
48 | * @since 0.0.13 | |
49 | */ | |
50 | public T parseField(String header) throws UnParsableHeaderException; | |
51 | } |