1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.core5.http.message;
29
30 import org.apache.hc.core5.util.Args;
31
32 /**
33 * This class represents a context of a parsing operation:
34 * <ul>
35 * <li>the current position the parsing operation is expected to start at</li>
36 * <li>the bounds limiting the scope of the parsing operation</li>
37 * </ul>
38 *
39 * @since 4.0
40 */
41 public class ParserCursor {
42
43 private final int lowerBound;
44 private final int upperBound;
45 private int pos;
46
47 public ParserCursor(final int lowerBound, final int upperBound) {
48 super();
49 Args.notNegative(lowerBound, "lowerBound");
50 Args.check(lowerBound <= upperBound, "lowerBound cannot be greater than upperBound");
51 this.lowerBound = lowerBound;
52 this.upperBound = upperBound;
53 this.pos = lowerBound;
54 }
55
56 public int getLowerBound() {
57 return this.lowerBound;
58 }
59
60 public int getUpperBound() {
61 return this.upperBound;
62 }
63
64 public int getPos() {
65 return this.pos;
66 }
67
68 public void updatePos(final int pos) {
69 if (pos < this.lowerBound) {
70 throw new IndexOutOfBoundsException("pos: "+pos+" < lowerBound: "+this.lowerBound);
71 }
72 if (pos > this.upperBound) {
73 throw new IndexOutOfBoundsException("pos: "+pos+" > upperBound: "+this.upperBound);
74 }
75 this.pos = pos;
76 }
77
78 public boolean atEnd() {
79 return this.pos >= this.upperBound;
80 }
81
82 @Override
83 public String toString() {
84 final StringBuilder buffer = new StringBuilder();
85 buffer.append('[');
86 buffer.append(Integer.toString(this.lowerBound));
87 buffer.append('>');
88 buffer.append(Integer.toString(this.pos));
89 buffer.append('>');
90 buffer.append(Integer.toString(this.upperBound));
91 buffer.append(']');
92 return buffer.toString();
93 }
94
95 }