JsonOperations.java

package org.springframework.roo.addon.json;

import org.springframework.roo.model.JavaType;

/**
 * Interface of operations for addon-json operations.
 * 
 * @author Stefan Schmidt
 * @since 1.1
 */
public interface JsonOperations {

    /**
     * Annotate all types in the project which are annotated with @
     * {@link org.springframework.roo.addon.javabean.RooJavaBean}.
     */
    @Deprecated
    void annotateAll();

    /**
     * Annotate all types in the project which are annotated with @
     * {@link org.springframework.roo.addon.javabean.RooJavaBean}.
     * 
     * @param deepSerialize Indication if deep serialization should be enabled
     *            (optional)
     */
    void annotateAll(boolean deepSerialize);

    /**
     * Annotate a given {@link JavaType} with @{@link RooJson} annotation.
     * 
     * @param type The type to annotate (required)
     * @param rootName The root name which should be used to wrap the JSON
     *            document (optional)
     */
    @Deprecated
    void annotateType(JavaType type, String rootName);

    /**
     * Annotate a given {@link JavaType} with @{@link RooJson} annotation.
     * 
     * @param type The type to annotate (required)
     * @param rootName The root name which should be used to wrap the JSON
     *            document (optional)
     * @param deepSerialize Indication if deep serialization should be enabled
     *            (optional)
     */
    void annotateType(JavaType type, String rootName, boolean deepSerialize);

    /**
     * Indicates whether this commands for this add-on should be available.
     * 
     * @return true if commands are available
     */
    boolean isJsonInstallationPossible();
}