org.nuiton.eugene.models.object.ObjectModelOperation Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * EUGene :: EUGene
 * 
 * $Id: ObjectModelOperation.java 1012 2010-11-28 11:24:27Z tchemit $
 * $HeadURL: https://nuiton.org/svn/eugene/tags/eugene-2.7.4/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelOperation.java $
 * %%
 * Copyright (C) 2004 - 2010 CodeLutin
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */

package org.nuiton.eugene.models.object;

import java.util.Collection;
import java.util.Set;

/**
* Abstraction for the operation node of object model trees.
* This object presents all information concerning the given operation.
* 
* Created: 14 janv. 2004
*
* @author Cédric Pineau 
* Copyright Code Lutin
* @version $Revision: 1012 $
*
* Last update : $Date: 2010-11-28 12:24:27 +0100 (Sun, 28 Nov 2010) $
* by : $Author: tchemit $
*/
public interface ObjectModelOperation extends ObjectModelElement {

    /**
    * Returns the return type of this operation.
    *
    * @return the return type of this operation.
    */
    String getReturnType();

    /**
    * Returns the visibility of this operation.
    * Possible values includes public, protected and private.
    *
    * @return the visibility of this operation.
    */
    String getVisibility();

    /**
    * Returns whether this operation is abstract or not.
    *
    * @return a boolean indicating whether this operation is abstract or not.
    */
    boolean isAbstract();

    /**
    * Returns all parameters defined on this operation.
    * @see ObjectModelParameter
    *
    * @return a Collection containing all parameters defined on this operation.
    */
    Collection getParameters();

    /**
     * Return the return parameter of the operation
     * @return an ObjectModelParameter representing the return parameter
     */
    ObjectModelParameter getReturnParameter();

//    /**
//    * In implementation you must write a good equals method
//    */
//    boolean equals(Object o);

    /**
     * Returns all exception qualified names thrown by this operation
     * (as strings)
     *
     * @return a Set containing the exceptions strings
     */
    Set getExceptions();

    /**
     * Return body of the operation (source code)
     * @return body of the operation (source code)
     */
    String getBodyCode();

} //ObjectModelOperation