org.directwebremoting.io.RawData Maven / Gradle / Ivy

Go to download

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

DWR is easy Ajax for Java. It makes it simple to call Java code directly from Javascript. It gets rid of almost all the boiler plate code between the web browser and your Java code.

There is a newer version: 3.0.2-RELEASE

Show newest version

/*
 * Copyright 2005 Joe Walker
 *
 * Licensed 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.directwebremoting.io;

import org.directwebremoting.extend.InboundContext;
import org.directwebremoting.extend.InboundVariable;
import org.directwebremoting.json.InvalidJsonException;
import org.directwebremoting.util.JavascriptUtil;

/**
 * Sometimes DWR can't know at runtime the type of the inbound data, this class
 * allows us to defer conversion until we know more about the type we should
 * be converting to.
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 */
public class RawData
{
    /**
     * RawData is immutable. Setup the raw string data that we wrap
     * @param inboundContext The context variables that could be associated with this
     * @param inboundVariable The variable we are delaying marshalling
     */
    public RawData(InboundVariable inboundVariable, InboundContext inboundContext)
    {
        this.inboundVariable = inboundVariable;
        this.inboundContext = inboundContext;
    }

    /**
     * @return The context variables that could be associated with this
     */
    public InboundContext getInboundContext()
    {
        return inboundContext;
    }

    /**
     * @return The variable we are delaying marshalling
     */
    public InboundVariable getInboundVariable()
    {
        return inboundVariable;
    }

    /**
     * @see InboundVariable#getJsonValue(org.directwebremoting.extend.InboundVariable.OnJsonParseError)
     * @return A JSON approximation of this data
     */
    public String toJsonString()
    {
        try
        {
            return inboundVariable.getJsonValue(InboundVariable.OnJsonParseError.Hack).toExternalRepresentation();
        }
        catch (InvalidJsonException ex)
        {
            return "{ 'error':'The object could not be represented in JSON: " + JavascriptUtil.escapeJavaScript(ex.toString()) + "' }";
        }
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString()
    {
        return toJsonString();
    }

    /**
     * The context variables that could be associated with this
     */
    private InboundContext inboundContext;

    /**
     * The variable we are delaying marshalling
     */
    private InboundVariable inboundVariable;
}