1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.mina.filter.codec.textline;
21
22 import java.io.ByteArrayOutputStream;
23 import java.io.PrintWriter;
24
25 /**
26 * A delimiter which is appended to the end of a text line, such as
27 * <tt>CR/LF</tt>.
28 *
29 * @author The Apache MINA Project (dev@mina.apache.org)
30 * @version $Rev: 576217 $, $Date: 2007-09-17 01:55:27 +0200 (lun, 17 sep 2007) $
31 */
32 public class LineDelimiter {
33 /**
34 * the line delimiter constant of the current O/S.
35 */
36 public static final LineDelimiter DEFAULT;
37
38 static {
39 ByteArrayOutputStream bout = new ByteArrayOutputStream();
40 PrintWriter out = new PrintWriter(bout);
41 out.println();
42 DEFAULT = new LineDelimiter(new String(bout.toByteArray()));
43 }
44
45 /**
46 * A special line delimiter which is used for auto-detection of
47 * EOL in {@link TextLineDecoder}. If this delimiter is used,
48 * {@link TextLineDecoder} will consider both <tt>'\r'</tt> and
49 * <tt>'\n'</tt> as a delimiter.
50 */
51 public static final LineDelimiter AUTO = new LineDelimiter("");
52
53 /**
54 * The line delimiter constant of UNIX (<tt>"\n"</tt>)
55 */
56 public static final LineDelimiter UNIX = new LineDelimiter("\n");
57
58 /**
59 * The line delimiter constant of MS Windows/DOS (<tt>"\r\n"</tt>)
60 */
61 public static final LineDelimiter WINDOWS = new LineDelimiter("\r\n");
62
63 /**
64 * The line delimiter constant of Mac OS (<tt>"\r"</tt>)
65 */
66 public static final LineDelimiter MAC = new LineDelimiter("\r");
67
68 /**
69 * The line delimiter constant for NUL-terminated text protocols
70 * such as Flash XML socket (<tt>"\0"</tt>)
71 */
72 public static final LineDelimiter NUL = new LineDelimiter("\0");
73
74 private final String value;
75
76 /**
77 * Creates a new line delimiter with the specified <tt>value</tt>.
78 */
79 public LineDelimiter(String value) {
80 if (value == null) {
81 throw new NullPointerException("delimiter");
82 }
83 this.value = value;
84 }
85
86 /**
87 * Return the delimiter string.
88 */
89 public String getValue() {
90 return value;
91 }
92
93 @Override
94 public int hashCode() {
95 return value.hashCode();
96 }
97
98 @Override
99 public boolean equals(Object o) {
100 if (!(o instanceof LineDelimiter)) {
101 return false;
102 }
103
104 LineDelimiter that = (LineDelimiter) o;
105 return this.value.equals(that.value);
106 }
107
108 @Override
109 public String toString() {
110 StringBuffer buf = new StringBuffer();
111 buf.append("delimiter:");
112 if (value.length() == 0) {
113 buf.append(" auto");
114 } else {
115 for (int i = 0; i < value.length(); i++) {
116 buf.append(" 0x");
117 buf.append(Integer.toHexString(value.charAt(i)));
118 }
119 }
120 return buf.toString();
121 }
122 }