- java.lang.Object
-
- com.sun.tools.xjc.generator.bean.MethodWriter
-
public abstract class MethodWriter extends Object
The back-end may or may not generate the content interface separately from the implementation class. If so, a method needs to be declared on both the interface and the implementation class.This class hides those details and allow callers to declare methods just once.
- Author:
- Kohsuke Kawaguchi ([email protected])
-
-
Field Summary
Fields Modifier and Type Field Description protected JCodeModel
codeModel
-
Constructor Summary
Constructors Modifier Constructor Description protected
MethodWriter(ClassOutline context)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract JVar
addParameter(JType type, String name)
Adds a parameter to the previously declared method.JVar
addParameter(Class type, String name)
abstract JMethod
declareMethod(JType returnType, String methodName)
Declares a method in both the interface and the implementation.JMethod
declareMethod(Class returnType, String methodName)
abstract JDocComment
javadoc()
To generate javadoc for the previously declared method, use this method to obtain aJDocComment
object.
-
-
-
Field Detail
-
codeModel
protected final JCodeModel codeModel
-
-
Constructor Detail
-
MethodWriter
protected MethodWriter(ClassOutline context)
-
-
Method Detail
-
declareMethod
public abstract JMethod declareMethod(JType returnType, String methodName)
Declares a method in both the interface and the implementation.- Returns:
- JMethod object that represents a newly declared method on the implementation class.
-
javadoc
public abstract JDocComment javadoc()
To generate javadoc for the previously declared method, use this method to obtain aJDocComment
object. This may return a value different from declareMethod().javadoc().
-
addParameter
public abstract JVar addParameter(JType type, String name)
Adds a parameter to the previously declared method.- Returns:
- JVar object that represents a newly added parameter on the implementation class.
-
-