org.elasticsearch.common.xcontent.FromXContentBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.elasticsearch Show documentation

The newest version!

/*
 * 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.ParseFieldMatcher;
import org.elasticsearch.common.io.stream.StreamableReader;

import java.io.IOException;

/**
 * Indicates that the class supports XContent deserialization.
 *
 * This interface is similar to what {@link StreamableReader} does, only it works with XContent serialization
 * instead of binary serialization.
 */
public interface FromXContentBuilder {
    /**
     * Parses an object with the type T from parser
     */
    T fromXContent(XContentParser parser, ParseFieldMatcher parseFieldMatcher) throws IOException;
}