Thu, 12 Oct 2017 19:44:07 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.codemodel.internal; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.util.Iterator; |
aoqi@0 | 29 | |
aoqi@0 | 30 | /** |
aoqi@0 | 31 | * The common aspect of a package and a class. |
aoqi@0 | 32 | */ |
aoqi@0 | 33 | public interface JClassContainer { |
aoqi@0 | 34 | |
aoqi@0 | 35 | /** |
aoqi@0 | 36 | * Returns true if the container is a class. |
aoqi@0 | 37 | */ |
aoqi@0 | 38 | boolean isClass(); |
aoqi@0 | 39 | /** |
aoqi@0 | 40 | * Returns true if the container is a package. |
aoqi@0 | 41 | */ |
aoqi@0 | 42 | boolean isPackage(); |
aoqi@0 | 43 | |
aoqi@0 | 44 | /** |
aoqi@0 | 45 | * Add a new class to this package/class. |
aoqi@0 | 46 | * |
aoqi@0 | 47 | * @param mods |
aoqi@0 | 48 | * Modifiers for this class declaration |
aoqi@0 | 49 | * |
aoqi@0 | 50 | * @param name |
aoqi@0 | 51 | * Name of class to be added to this package |
aoqi@0 | 52 | * |
aoqi@0 | 53 | * @return Newly generated class |
aoqi@0 | 54 | * |
aoqi@0 | 55 | * @exception JClassAlreadyExistsException |
aoqi@0 | 56 | * When the specified class/interface was already created. |
aoqi@0 | 57 | */ |
aoqi@0 | 58 | JDefinedClass _class(int mods, String name) throws JClassAlreadyExistsException; |
aoqi@0 | 59 | |
aoqi@0 | 60 | /** |
aoqi@0 | 61 | * Add a new public class to this class/package. |
aoqi@0 | 62 | * |
aoqi@0 | 63 | * @exception JClassAlreadyExistsException |
aoqi@0 | 64 | * When the specified class/interface was already created. |
aoqi@0 | 65 | */ |
aoqi@0 | 66 | public JDefinedClass _class(String name) throws JClassAlreadyExistsException; |
aoqi@0 | 67 | |
aoqi@0 | 68 | /** |
aoqi@0 | 69 | * Add an interface to this class/package. |
aoqi@0 | 70 | * |
aoqi@0 | 71 | * @param mods |
aoqi@0 | 72 | * Modifiers for this interface declaration |
aoqi@0 | 73 | * |
aoqi@0 | 74 | * @param name |
aoqi@0 | 75 | * Name of interface to be added to this package |
aoqi@0 | 76 | * |
aoqi@0 | 77 | * @return Newly generated interface |
aoqi@0 | 78 | * |
aoqi@0 | 79 | * @exception JClassAlreadyExistsException |
aoqi@0 | 80 | * When the specified class/interface was already created. |
aoqi@0 | 81 | */ |
aoqi@0 | 82 | public JDefinedClass _interface(int mods, String name) throws JClassAlreadyExistsException; |
aoqi@0 | 83 | |
aoqi@0 | 84 | /** |
aoqi@0 | 85 | * Adds a public interface to this package. |
aoqi@0 | 86 | * |
aoqi@0 | 87 | * @exception JClassAlreadyExistsException |
aoqi@0 | 88 | * When the specified class/interface was already created. |
aoqi@0 | 89 | */ |
aoqi@0 | 90 | public JDefinedClass _interface(String name) throws JClassAlreadyExistsException; |
aoqi@0 | 91 | |
aoqi@0 | 92 | /** |
aoqi@0 | 93 | * Create a new class or a new interface. |
aoqi@0 | 94 | * |
aoqi@0 | 95 | * @deprecated |
aoqi@0 | 96 | * use {@link #_class(int, String, ClassType)} |
aoqi@0 | 97 | */ |
aoqi@0 | 98 | public JDefinedClass _class(int mods, String name, boolean isInterface ) |
aoqi@0 | 99 | throws JClassAlreadyExistsException; |
aoqi@0 | 100 | |
aoqi@0 | 101 | /** |
aoqi@0 | 102 | * Creates a new class/enum/interface/annotation. |
aoqi@0 | 103 | */ |
aoqi@0 | 104 | public JDefinedClass _class(int mods, String name, ClassType kind ) |
aoqi@0 | 105 | throws JClassAlreadyExistsException; |
aoqi@0 | 106 | |
aoqi@0 | 107 | |
aoqi@0 | 108 | /** |
aoqi@0 | 109 | * Returns an iterator that walks the nested classes defined in this |
aoqi@0 | 110 | * class. |
aoqi@0 | 111 | */ |
aoqi@0 | 112 | public Iterator<JDefinedClass> classes(); |
aoqi@0 | 113 | |
aoqi@0 | 114 | /** |
aoqi@0 | 115 | * Parent JClassContainer. |
aoqi@0 | 116 | * |
aoqi@0 | 117 | * If this is a package, this method returns a parent package, |
aoqi@0 | 118 | * or null if this package is the root package. |
aoqi@0 | 119 | * |
aoqi@0 | 120 | * If this is an outer-most class, this method returns a package |
aoqi@0 | 121 | * to which it belongs. |
aoqi@0 | 122 | * |
aoqi@0 | 123 | * If this is an inner class, this method returns the outer |
aoqi@0 | 124 | * class. |
aoqi@0 | 125 | */ |
aoqi@0 | 126 | public JClassContainer parentContainer(); |
aoqi@0 | 127 | |
aoqi@0 | 128 | /** |
aoqi@0 | 129 | * Gets the nearest package parent. |
aoqi@0 | 130 | * |
aoqi@0 | 131 | * <p> |
aoqi@0 | 132 | * If <tt>this.isPackage()</tt>, then return <tt>this</tt>. |
aoqi@0 | 133 | */ |
aoqi@0 | 134 | public JPackage getPackage(); |
aoqi@0 | 135 | |
aoqi@0 | 136 | /** |
aoqi@0 | 137 | * Get the root code model object. |
aoqi@0 | 138 | */ |
aoqi@0 | 139 | public JCodeModel owner(); |
aoqi@0 | 140 | |
aoqi@0 | 141 | /** |
aoqi@0 | 142 | * Add an annotationType Declaration to this package |
aoqi@0 | 143 | * @param name |
aoqi@0 | 144 | * Name of the annotation Type declaration to be added to this package |
aoqi@0 | 145 | * @return |
aoqi@0 | 146 | * newly created Annotation Type Declaration |
aoqi@0 | 147 | * @exception JClassAlreadyExistsException |
aoqi@0 | 148 | * When the specified class/interface was already created. |
aoqi@0 | 149 | |
aoqi@0 | 150 | */ |
aoqi@0 | 151 | public JDefinedClass _annotationTypeDeclaration(String name) throws JClassAlreadyExistsException; |
aoqi@0 | 152 | |
aoqi@0 | 153 | /** |
aoqi@0 | 154 | * Add a public enum to this package |
aoqi@0 | 155 | * @param name |
aoqi@0 | 156 | * Name of the enum to be added to this package |
aoqi@0 | 157 | * @return |
aoqi@0 | 158 | * newly created Enum |
aoqi@0 | 159 | * @exception JClassAlreadyExistsException |
aoqi@0 | 160 | * When the specified class/interface was already created. |
aoqi@0 | 161 | |
aoqi@0 | 162 | */ |
aoqi@0 | 163 | public JDefinedClass _enum (String name) throws JClassAlreadyExistsException; |
aoqi@0 | 164 | |
aoqi@0 | 165 | } |