com.sun.jdo.spi.persistence.utility.generator.JavaFileWriter Maven / Gradle / Ivy
Show all versions of payara-embedded-web Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* JavaFileWriter.java
*
* Created on November 14, 2001, 5:11 PM
*/
package com.sun.jdo.spi.persistence.utility.generator;
import java.io.IOException;
/**
* This interface can be used to describe a java source file. The resulting
* source definition can be viewed by calling {@link java.lang.Object#toString}
* or saved to a file by calling {@link #save}. The semantics of this
* interface are as follows:
* - Resource allocation is deferred to save - there is no need to worry about
* resource cleanup if an IOException is thrown from other methods (addImport,
* setPackage, addClass).
* - Any implementation of this interface must handle the closing of resources
* during save if an exception is thrown.
*
*
* Use this interface in conjunction with one or more {@link JavaClassWriter}
* instances to describe the class(es) in a java file.
*
* @author raccah
*/
public interface JavaFileWriter
{
/** Sets the package for this file. Note that the package name format
* must be package style (that is - it can contain . but not / or $).
* @param packageName The name of the package for this source file.
* @param comments The comments shown just above the package statement.
* The comments are passed as an array so the line separators can be added
* by the implementation. Note that not all implementations will choose
* to make use of this comment.
* @throws IOException If the package cannot be set.
*/
public void setPackage (String packageName, String[] comments)
throws IOException;
/** Adds an import statement for this source file.
* @param importName Name of the class or package (including the *) to be
* imported. This string should not contain "import" or the ;
* @param comments The comments shown just above the import statement.
* The comments are passed as an array so the line separators can be added
* by the implementation. Note that not all implementations will choose
* to make use of this comment.
* @throws IOException If the import information cannot be added.
*/
public void addImport (String importName, String[] comments)
throws IOException;
/** Adds a class to this source file.
* @param classWriter The definition of the class.
* @throws IOException If the class information cannot be added.
*/
public void addClass (JavaClassWriter classWriter) throws IOException;
/** Saves the file by writing out the source contents to whatever
* file (or alternate representation) was specified (usually by the
* constructor of the implementation class.
* @throws IOException If the file cannot be saved.
*/
public void save () throws IOException;
}