/
BTCharacterHandlerType.java
47 lines (42 loc) · 1.45 KB
/
BTCharacterHandlerType.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/*
* Copyright © 2019 Mark Raynsford <code@io7m.com> http://io7m.com
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
* IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package com.io7m.blackthorne.api;
/**
* A function that, given a string, returns a {@code T}.
*
* @param <T> The type of returned values
*/
public interface BTCharacterHandlerType<T>
{
/**
* Parse a text value.
*
* @param context The parsing context
* @param characters The character array
* @param offset The offset into the character array of the start of the data
* @param length The number of characters in the data
*
* @return A value of {@code T}
*
* @throws Exception On errors
*/
T parse(
BTElementParsingContextType context,
char[] characters,
int offset,
int length)
throws Exception;
}