com.jsoniter.spi.Extension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsoniter Show documentation

jsoniter (json-iterator) is fast and flexible JSON parser available in Java and Go

There is a newer version: 0.9.23

package com.jsoniter.spi;

import java.lang.reflect.Type;

public interface Extension {
    /**
     * Choose the implementation class for interface types
     *
     * @param type the type to decode to, could be class or parameterized type
     * @return the implementation type to use
     */
    Type chooseImplementation(Type type);

    /**
     * Can this extension create object instance for given interface type
     *
     * @param clazz the interface
     * @return true if can create, false if can not
     */
    boolean canCreate(Class clazz);

    /**
     * Create object instance for given interface type
     *
     * @param clazz the interface
     * @return the object instance, throw exception if can not create
     */
    Object create(Class clazz);

    /**
     * Customize type decoding
     *
     * @param cacheKey name of the decoder
     * @param type     change how to decode the type
     * @return null, if no special customization needed
     */
    Decoder createDecoder(String cacheKey, Type type);

    /**
     * Customize type encoding
     *
     * @param cacheKey name of the encoder
     * @param type     change how to encode the type
     * @return null, if not special customization needed
     */
    Encoder createEncoder(String cacheKey, Type type);

    /**
     * Update how binding is done for the class
     *
     * @param desc binding information
     */
    void updateClassDescriptor(ClassDescriptor desc);
}