GlueGen: src/java/com/jogamp/gluegen/JavaCodeUnit.java Source File

GlueGen v2.6.0 GlueGen, Native Binding Generator for Java™ (public API).

JavaCodeUnit.java
Go to the documentation of this file.
1/**
2 * Copyright 2023 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28package com.jogamp.gluegen;
29
30import java.io.IOException;
31
32/**
33 * Java code unit (a generated Java source file),
34 * covering multiple {@link FunctionEmitter} allowing to unify output, decoration and dynamic helper code injection per unit.
35 **/
36 public class JavaCodeUnit extends CodeUnit {
37 /** Package name of this Java unit */
38 public final String pkgName;
39 /** Simple class name of this Java unit */
40 public final String className;
41
42 /**
43 * @param filename the class's full filename to open w/ write access
44 * @param packageName the package name of the class
45 * @param simpleClassName the simple class name, i.e. w/o package name or c-file basename
46 * @param generator informal optional object that is creating this unit, used to be mentioned in a warning message if not null.
47 * @throws IOException
48 */
49 public JavaCodeUnit(final String filename, final String packageName, final String simpleClassName, final Object generator) throws IOException {
50 super(filename, generator);
51 this.pkgName = packageName;
52 this.className = simpleClassName;
53 CodeGenUtils.emitAutogeneratedWarning(output, generator, "Java-Unit: [pkg "+packageName+", cls "+simpleClassName+"], "+filename);
54 }
55
56 @Override
57 public String toString() { return "JavaCodeUnit[unit "+pkgName+"."+className+", file "+filename+"]"; }
58}
com.jogamp.gluegen.CodeGenUtils
Definition: CodeGenUtils.java:45
com.jogamp.gluegen.CodeGenUtils.emitAutogeneratedWarning
static void emitAutogeneratedWarning(final PrintWriter w, final Object generator, final String customLine)
Definition: CodeGenUtils.java:76
com.jogamp.gluegen.CodeUnit
General code unit (a generated C or Java source file), covering multiple FunctionEmitter allowing to ...
Definition: CodeUnit.java:42
com.jogamp.gluegen.CodeUnit.filename
final String filename
Definition: CodeUnit.java:43
com.jogamp.gluegen.CodeUnit.output
final PrintWriter output
Definition: CodeUnit.java:44
com.jogamp.gluegen.JavaCodeUnit
Java code unit (a generated Java source file), covering multiple FunctionEmitter allowing to unify ou...
Definition: JavaCodeUnit.java:36
com.jogamp.gluegen.JavaCodeUnit.toString
String toString()
Definition: JavaCodeUnit.java:57
com.jogamp.gluegen.JavaCodeUnit.pkgName
final String pkgName
Package name of this Java unit.
Definition: JavaCodeUnit.java:38
com.jogamp.gluegen.JavaCodeUnit.JavaCodeUnit
JavaCodeUnit(final String filename, final String packageName, final String simpleClassName, final Object generator)
Definition: JavaCodeUnit.java:49
com.jogamp.gluegen.JavaCodeUnit.className
final String className
Simple class name of this Java unit.
Definition: JavaCodeUnit.java:40