Modifier and Type	Class and Description
public static class	FunctionEmitter.EmissionModifier

Modifier and Type	Field and Description
protected final JavaConfiguration	cfg
private CommentEmitter	commentEmitter
private final PrintWriter	defaultOutput
private final boolean	isInterface
private final ArrayList<FunctionEmitter.EmissionModifier>	modifiers
public static final FunctionEmitter.EmissionModifier	STATIC

Access	Constructor and Description
public	FunctionEmitter(final PrintWriter defaultOutput, final boolean isInterface, final JavaConfiguration configuration) Constructs the FunctionEmitter with a CommentEmitter that emits nothing.
public	FunctionEmitter(final FunctionEmitter arg) Makes this FunctionEmitter a copy of the passed one.

Method Summary

Modifier and Type	Method and Description
public void	addModifier(final FunctionEmitter.EmissionModifier m)
public void	addModifiers(final Iterator<FunctionEmitter.EmissionModifier> mi)
public void	clearModifiers()
public void	emit(final PrintWriter output) Emit the function to the specified output (instead of the default output).
public final void	emit() Emit the function to the default output (the output that was passed to the constructor)
protected abstract int	emitArguments(PrintWriter writer) Returns the number of arguments emitted.
protected abstract void	emitBody(PrintWriter writer)
protected void	emitDocComment(final PrintWriter writer)
protected int	emitModifiers(final PrintWriter writer)
protected abstract void	emitName(PrintWriter writer)
protected abstract void	emitReturnType(PrintWriter writer)
protected void	emitSignature(final PrintWriter writer)
protected String	getBaseIndentString()
public CommentEmitter	getCommentEmitter() Get the comment emitter for this FunctionEmitter.
protected String	getCommentEndString()
protected String	getCommentStartString()
public abstract FunctionSymbol	getCSymbol()
public PrintWriter	getDefaultOutput()
public abstract String	getImplName()
public abstract String	getInterfaceName()
public Iterator<FunctionEmitter.EmissionModifier>	getModifiers()
public abstract String	getNativeName()
public boolean	hasModifier(final FunctionEmitter.EmissionModifier m)
public boolean	isInterface()
public boolean	removeModifier(final FunctionEmitter.EmissionModifier m)
public void	setCommentEmitter(final CommentEmitter cEmitter) Set the object that will emit the comment for this function.
public String	toString() Overrides java.lang.Object.toString. Returns, as a String, whatever `emit` would output.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

cfg	back to summary
protected final JavaConfiguration cfg

commentEmitter	back to summary
private CommentEmitter commentEmitter

defaultOutput	back to summary
private final PrintWriter defaultOutput

isInterface	back to summary
private final boolean isInterface

modifiers	back to summary
private final ArrayList<FunctionEmitter.EmissionModifier> modifiers

STATIC	back to summary
public static final FunctionEmitter.EmissionModifier STATIC

Constructor Detail

FunctionEmitter	back to summary
public FunctionEmitter(final PrintWriter defaultOutput, final boolean isInterface, final JavaConfiguration configuration) Constructs the FunctionEmitter with a CommentEmitter that emits nothing.

FunctionEmitter	back to summary
public FunctionEmitter(final FunctionEmitter arg) Makes this FunctionEmitter a copy of the passed one.

Method Detail

addModifier	back to summary
public void addModifier(final FunctionEmitter.EmissionModifier m)

addModifiers	back to summary
public void addModifiers(final Iterator<FunctionEmitter.EmissionModifier> mi)

clearModifiers	back to summary
public void clearModifiers()

emit	back to summary
public void emit(final PrintWriter output) Emit the function to the specified output (instead of the default output).

emit	back to summary
public final void emit() Emit the function to the default output (the output that was passed to the constructor)

emitArguments	back to summary
protected abstract int emitArguments(PrintWriter writer) Returns the number of arguments emitted.

emitBody	back to summary
protected abstract void emitBody(PrintWriter writer)

emitDocComment	back to summary
protected void emitDocComment(final PrintWriter writer)

emitModifiers	back to summary
protected int emitModifiers(final PrintWriter writer)

emitName	back to summary
protected abstract void emitName(PrintWriter writer)

emitReturnType	back to summary
protected abstract void emitReturnType(PrintWriter writer)

emitSignature	back to summary
protected void emitSignature(final PrintWriter writer)

getBaseIndentString	back to summary
protected String getBaseIndentString()

getCommentEmitter	back to summary
public CommentEmitter getCommentEmitter() Get the comment emitter for this FunctionEmitter. The return value may be null, in which case no comment emitter has been set.

getCommentEndString	back to summary
protected String getCommentEndString()

getCommentStartString	back to summary
protected String getCommentStartString()

getCSymbol	back to summary
public abstract FunctionSymbol getCSymbol()

getDefaultOutput	back to summary
public PrintWriter getDefaultOutput()

getImplName	back to summary
public abstract String getImplName()

getInterfaceName	back to summary
public abstract String getInterfaceName()

getModifiers	back to summary
public Iterator<FunctionEmitter.EmissionModifier> getModifiers()

getNativeName	back to summary
public abstract String getNativeName()

hasModifier	back to summary
public boolean hasModifier(final FunctionEmitter.EmissionModifier m)

isInterface	back to summary
public boolean isInterface()

removeModifier	back to summary
public boolean removeModifier(final FunctionEmitter.EmissionModifier m)

setCommentEmitter	back to summary
public void setCommentEmitter(final CommentEmitter cEmitter) Set the object that will emit the comment for this function. If the parameter is null, no comment will be emitted.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns, as a String, whatever `emit` would output. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns, as a String, whatever emit would output.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

com.jogamp.gluegen back to summary

public Class FunctionEmitter.EmissionModifier

Class Inheritance

extends Object

java.lang.Object
com.jogamp.gluegen.FunctionEmitter.EmissionModifier

Field Summary

Modifier and Type	Field and Description
private final String	emittedForm

Constructor Summary

Access	Constructor and Description
protected	EmissionModifier(final String emittedForm)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object the reference object with which to compare. arg) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

emittedForm	back to summary
private final String emittedForm

Constructor Detail

EmissionModifier	back to summary
protected EmissionModifier(final String emittedForm)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object arg) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters arg:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object arg)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

arg:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations