All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.kohsuke.stapler.export.Flavor Maven / Gradle / Ivy

/*
 * Copyright (c) 2004-2010, Kohsuke Kawaguchi
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided
 * that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice, this list of
 *       conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.kohsuke.stapler.export;

import java.io.IOException;
import java.io.Writer;

import org.kohsuke.stapler.StaplerResponse;

/**
 * Export flavor.
 *
 * @author Kohsuke Kawaguchi
 */
public enum Flavor {
    JSON("application/json;charset=UTF-8") {
        public DataWriter createDataWriter(Object bean, Writer w, ExportConfig config) throws IOException {
            return new JSONDataWriter(w,config);
        }
    },
    JSONP("application/javascript;charset=UTF-8") {
        public DataWriter createDataWriter(Object bean, Writer w, ExportConfig config) throws IOException {
            return new JSONDataWriter(w,config);
        }
    },
    PYTHON("text/x-python;charset=UTF-8") {
        public DataWriter createDataWriter(Object bean, Writer w, ExportConfig config) throws IOException {
            return new PythonDataWriter(w,config);
        }
    },
    RUBY("text/x-ruby;charset=UTF-8") {
        public DataWriter createDataWriter(Object bean, Writer w, ExportConfig config) throws IOException {
            return new RubyDataWriter(w,config);
        }
    },
    XML("application/xml;charset=UTF-8") {
        public DataWriter createDataWriter(Object bean, Writer w, ExportConfig config) throws IOException {
            return new XMLDataWriter(bean,w,config);
        }
    };

    /**
     * Content-type of this flavor, including charset "UTF-8".
     */
    public final String contentType;

    Flavor(String contentType) {
        this.contentType = contentType;
    }

    public DataWriter createDataWriter(Object bean, StaplerResponse rsp) throws IOException {
        return createDataWriter(bean,rsp.getWriter());
    }
    public DataWriter createDataWriter(Object bean, Writer w) throws IOException {
        return createDataWriter(bean,w,new ExportConfig().withFlavor(this));
    }
    public abstract DataWriter createDataWriter(Object bean, Writer w, ExportConfig config) throws IOException;
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy