com.arakelian.elastic.doc.ValueSerializer Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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 com.arakelian.elastic.doc;

import com.arakelian.elastic.model.Field;

public interface ValueSerializer {
    /**
     * 
     * Converts a complex Java type to a simple type, suitable for rendering to JSON without any
     * further type conversion.
     * 
     * 
     * 
     * Supported Java types:
     * 
     * 
     * CharSequence for JSON strings
     * Boolean for JSON booleans
     * Number for JSON numbers
     * Collection or Object[] for JSON arrays
     * Map for JSON objects
     * 
     * 
     * @param field
     *            Elastic field definition
     * @param value
     *            field value
     * @return a Java object that can be rendered to JSON without any further conversion.
     * @throws ValueException
     *             if value cannot be converted
     */
    public Object serialize(Field field, Object value) throws ValueException;
}