org.codehaus.groovy.groovydoc.GroovyClassDoc Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of groovy-all Show documentation

Groovy: A powerful, dynamic language for the JVM

There is a newer version: 3.0.21

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.codehaus.groovy.groovydoc;

public interface GroovyClassDoc extends GroovyType, GroovyProgramElementDoc {
    GroovyConstructorDoc[] constructors();

    GroovyConstructorDoc[] constructors(boolean filter);

    boolean definesSerializableFields();

    GroovyFieldDoc[] enumConstants();

    GroovyFieldDoc[] fields();

    GroovyFieldDoc[] properties();

    GroovyFieldDoc[] fields(boolean filter);

    GroovyClassDoc findClass(String className);

    GroovyClassDoc[] importedClasses();

    GroovyPackageDoc[] importedPackages();

    GroovyClassDoc[] innerClasses();

    GroovyClassDoc[] innerClasses(boolean filter);

    GroovyClassDoc[] interfaces();

    GroovyType[] interfaceTypes();

    boolean isAbstract();

    boolean isExternalizable();

    boolean isSerializable();

    GroovyMethodDoc[] methods();

    GroovyMethodDoc[] methods(boolean filter);

    GroovyFieldDoc[] serializableFields();

    GroovyMethodDoc[] serializationMethods();

    boolean subclassOf(GroovyClassDoc gcd);

    GroovyClassDoc superclass();

    GroovyType superclassType();

    String getFullPathName(); // not in Java Doclet API

    String getRelativeRootPath(); // not in Java Doclet API
}