1 /* 2 * Copyright (c) 2009-2010 jMonkeyEngine 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: 8 * 9 * * Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 package com.jme3.export; 34 35 import java.io.File; 36 import java.io.IOException; 37 import java.io.OutputStream; 38 39 /** 40 * <code>JmeExporter</code> specifies an export implementation for jME3 41 * data. 42 */ 43 public interface JmeExporter { 44 45 /** 46 * Export the {@link Savable} to an OutputStream. 47 * 48 * @param object The savable to export 49 * @param f The output stream 50 * @return Always returns true. If an error occurs during export, 51 * an exception is thrown 52 * @throws IOException If an io exception occurs during export 53 */ save(Savable object, OutputStream f)54 public boolean save(Savable object, OutputStream f) throws IOException; 55 56 /** 57 * Export the {@link Savable} to a file. 58 * 59 * @param object The savable to export 60 * @param f The file to export to 61 * @return Always returns true. If an error occurs during export, 62 * an exception is thrown 63 * @throws IOException If an io exception occurs during export 64 */ save(Savable object, File f)65 public boolean save(Savable object, File f) throws IOException; 66 67 /** 68 * Returns the {@link OutputCapsule} for the given savable object. 69 * 70 * @param object The object to retrieve an output capsule for. 71 * @return 72 */ getCapsule(Savable object)73 public OutputCapsule getCapsule(Savable object); 74 } 75