com.thoughtworks.qdox.parser.structs.FieldDef Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of qdox Show documentation

QDox is a high speed, small footprint parser for extracting class/interface/method definitions from source files complete with JavaDoc @tags. It is designed to be used by active code generators or documentation tools.

There is a newer version: 2.1.0

Show newest version

package com.thoughtworks.qdox.parser.structs;

/*
 * 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.
 */

import java.util.LinkedHashSet;
import java.util.Set;

/**
 * Used for both fields and parameters
 */
public class FieldDef
    extends LocatedDef
{

    private String name;

    private TypeDef type;

    private Set modifiers = new LinkedHashSet();

    private int dimensions;

    private boolean isVarArgs;

    private boolean isEnumConstant;

    private String body;

    public FieldDef()
    {
    }

    public FieldDef( String name )
    {
        this.name = name;
    }

    /**
     * @param name the name to set
     */
    public void setName( String name )
    {
        this.name = name;
    }

    /**
     * @return the name
     */
    public String getName()
    {
        return name;
    }

    /**
     * @param type the type to set
     */
    public void setType( TypeDef type )
    {
        this.type = type;
    }

    /**
     * @return the type
     */
    public TypeDef getType()
    {
        return type;
    }

    /**
     * @param dimensions the dimensions to set
     */
    public void setDimensions( int dimensions )
    {
        this.dimensions = dimensions;
    }

    /**
     * @return the dimensions
     */
    public int getDimensions()
    {
        return dimensions;
    }

    /**
     * @param isVarArgs the isVarArgs to set
     */
    public void setVarArgs( boolean isVarArgs )
    {
        this.isVarArgs = isVarArgs;
    }

    /**
     * @return the isVarArgs
     */
    public boolean isVarArgs()
    {
        return isVarArgs;
    }

    /**
     * @param body the body to set
     */
    public void setBody( String body )
    {
        this.body = body;
    }

    /**
     * @return the body
     */
    public String getBody()
    {
        return body;
    }

    /**
     * @param modifiers the modifiers to set
     */
    public void setModifiers( Set modifiers )
    {
        this.modifiers = modifiers;
    }

    /**
     * @return the modifiers
     */
    public Set getModifiers()
    {
        return modifiers;
    }

    /**
     * @return true if this field is an enum constant, otherwise false
     */
    public boolean isEnumConstant()
    {
        return isEnumConstant;
    }

    /**
     * @param isEnumConstant value to specify if this field is an enum constant or not
     */
    public void setEnumConstant( boolean isEnumConstant )
    {
        this.isEnumConstant = isEnumConstant;
    }
}