/*
 * 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.index.mapper;

import java.io.IOException;


/**
 * A mapper that exists only as a mapper within a root object.
 */
public interface RootMapper extends Mapper {

    void preParse(ParseContext context) throws IOException;

    void postParse(ParseContext context) throws IOException;

    /**
     * Should the mapper be included in the root {@link org.elasticsearch.index.mapper.object.ObjectMapper}.
     */
    boolean includeInObject();

}

@@ -824,16 +824,80 @@
 apper;%0A%0A
+import org.elasticsearch.index.mapper.object.RootObjectMapper;%0A%0A
 import j
@@ -1043,64 +1043,261 @@
     
-void preParse(ParseContext context) throws IOException;%0A
+/**%0A     * Called before %7B@link #parse(ParseContext)%7D on the %7B@link RootObjectMapper%7D.%0A     */%0A    void preParse(ParseContext context) throws IOException;%0A%0A    /**%0A     * Called after %7B@link #parse(ParseContext)%7D on the %7B@link RootObjectMapper%7D.%0A     */
 %0A   
@@ -1411,16 +1411,23 @@
 the root
+%0A     *
  %7B@link 
@@ -1471,32 +1471,284 @@
 .ObjectMapper%7D.%0A
+     *%0A     * If this method returns true, then %7B@link #parse(ParseContext)%7D will be%0A     * called if the context has a property that matches the name of this%0A     * %7B@link RootMapper%7D. Otherwise %7B@link #parse(ParseContext)%7D will not%0A     * be called.%0A
      */%0A    bool

Document the contracts of the RootMapper API.