blob: 03e526ce8e5f71f92cfc115599a295ca134e2b84 (
plain)
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.elasticsearch.common.xcontent;
import org.elasticsearch.common.bytes.BytesReference;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
/**
* A generic abstraction on top of handling content, inspired by JSON and pull parsing.
*/
public interface XContent {
/**
* The type this content handles and produces.
*/
XContentType type();
byte streamSeparator();
/**
* Creates a new generator using the provided output stream.
*/
XContentGenerator createGenerator(OutputStream os) throws IOException;
/**
* Creates a new generator using the provided output stream and some filters.
*/
XContentGenerator createGenerator(OutputStream os, String[] filters) throws IOException;
/**
* Creates a parser over the provided string content.
*/
XContentParser createParser(String content) throws IOException;
/**
* Creates a parser over the provided input stream.
*/
XContentParser createParser(InputStream is) throws IOException;
/**
* Creates a parser over the provided bytes.
*/
XContentParser createParser(byte[] data) throws IOException;
/**
* Creates a parser over the provided bytes.
*/
XContentParser createParser(byte[] data, int offset, int length) throws IOException;
/**
* Creates a parser over the provided bytes.
*/
XContentParser createParser(BytesReference bytes) throws IOException;
/**
* Creates a parser over the provided reader.
*/
XContentParser createParser(Reader reader) throws IOException;
}
|
