001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: /*
038: * Use is subject to the license terms.
039: */
040: package com.sun.tools.xjc.generator.bean;
041:
042: import com.sun.codemodel.JCodeModel;
043: import com.sun.codemodel.JDocComment;
044: import com.sun.codemodel.JMethod;
045: import com.sun.codemodel.JType;
046: import com.sun.codemodel.JVar;
047: import com.sun.tools.xjc.outline.ClassOutline;
048:
049: /**
050: * The back-end may or may not generate the content interface
051: * separately from the implementation class. If so, a method
052: * needs to be declared on both the interface and the implementation class.
053: * <p>
054: * This class hides those details and allow callers to declare
055: * methods just once.
056: *
057: * @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
058: */
059: public abstract class MethodWriter {
060: protected final JCodeModel codeModel;
061:
062: protected MethodWriter(ClassOutline context) {
063: this .codeModel = context.parent().getCodeModel();
064: }
065:
066: /**
067: * Declares a method in both the interface and the implementation.
068: *
069: * @return
070: * JMethod object that represents a newly declared method
071: * on the implementation class.
072: */
073: public abstract JMethod declareMethod(JType returnType,
074: String methodName);
075:
076: public final JMethod declareMethod(Class returnType,
077: String methodName) {
078: return declareMethod(codeModel.ref(returnType), methodName);
079: }
080:
081: /**
082: * To generate javadoc for the previously declared method, use this method
083: * to obtain a {@link JDocComment} object. This may return a value
084: * different from declareMethod().javadoc().
085: */
086: public abstract JDocComment javadoc();
087:
088: /**
089: * Adds a parameter to the previously declared method.
090: *
091: * @return
092: * JVar object that represents a newly added parameter
093: * on the implementation class.
094: */
095: public abstract JVar addParameter(JType type, String name);
096:
097: public final JVar addParameter(Class type, String name) {
098: return addParameter(codeModel.ref(type), name);
099: }
100: }
|