JSONCircularReferenceMode.java

/*
 * SmartGWT (GWT for SmartClient)
 * Copyright 2008 and beyond, Isomorphic Software, Inc.
 *
 * SmartGWT is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.  SmartGWT is also
 * available under typical commercial license terms - see
 * http://smartclient.com/license
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 */

package org.vaadin.smartgwt.server.types;

/**
 * What the {@link com.smartgwt.client.util.JSONEncoder} should do when it encounters a circular reference in an object structure.
 */
public enum JSONCircularReferenceMode implements ValueEnum {
    /**
     * circular references in Arrays will be represented as a null entry, and objects will have a property with a null value
     */
    OMIT("omit"),

    /**
     * leave a string marker, the {@link com.smartgwt.client.util.JSONEncoder#setCircularReferenceMarker}, wherever a circular
     * reference is found
     */
    MARKER("marker"),

    /**
     * leave a string marker followed by the path to the first occurrence of the circular reference from the top of the object tree 
     * that was serialized. This potentially allows the original object graph to be reconstructed.
     */
    PATH("path");

    private String value;

    JSONCircularReferenceMode(String value) {
        this.value = value;
    }

    public String getValue() {
        return this.value;
    }
}