Author: echatellier Date: 2012-01-05 15:36:51 +0100 (Thu, 05 Jan 2012) New Revision: 1133 Url: http://nuiton.org/repositories/revision/eugene/1133 Log: Fix javadoc Modified: trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelClass.java Modified: trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelClass.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelClass.java 2012-01-05 14:35:09 UTC (rev 1132) +++ trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelClass.java 2012-01-05 14:36:51 UTC (rev 1133) @@ -5,7 +5,7 @@ * $Id$ * $HeadURL$ * %% - * Copyright (C) 2004 - 2010 CodeLutin + * Copyright (C) 2004 - 2012 CodeLutin Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -28,59 +28,61 @@ import java.util.Collection; /** -* Abstraction for the class node of object model trees. -* This object presents all information concerning the given class. -* -* Created: 14 janv. 2004 -* -* @author Cédric Pineau <pineau@codelutin.com> -* Copyright Code Lutin -* @version $Revision$ -* -* Last update : $Date$ -* by : $Author$ -*/ + * Abstraction for the class node of object model trees. + * This object presents all information concerning the given class. + * + * Created: 14 janv. 2004 + * + * @author Cédric Pineau <pineau@codelutin.com> + * Copyright Code Lutin + * @version $Revision$ + * + * Last update : $Date$ + * by : $Author$ + */ public interface ObjectModelClass extends ObjectModelClassifier { /** - * Returns all parent classes for this class. - * @return a Collection containing all parent ObjectModelClass for this class. - */ + * Returns all parent classes for this class. + * @return a Collection containing all parent ObjectModelClass for this class. + */ Collection<ObjectModelClass> getSuperclasses(); /** - * Returns all inner classes for this class. - * @return a Collection containing all inner ObjectModelClass for this class. - */ + * Returns all inner classes for this class. + * @return a Collection containing all inner ObjectModelClass for this class. + */ Collection<ObjectModelClassifier> getInnerClassifiers(); /** - * // FIXME 20100812 fix javadoc, what is a discrimator and what it is used for ? - * Returns the discriminator for the given superclass. - * - * @param superclass super class to get discriminator - * @return the discriminator for the given superclass as a String if it exists, null otherwise. - */ + * Returns the discriminator for the given superclass. + * (name of the inheritance relation). + * + * @param superclass super class to get discriminator + * @return the discriminator for the given superclass as a String if it exists, null otherwise. + */ String getDiscriminator(ObjectModelClass superclass); /** - * Returns all known direct specialized classes for this class. - * @return a Collection containing all known direct specialized ObjectModelClass for this class. - */ + * Returns all known direct specialized classes for this class. + * @return a Collection containing all known direct specialized ObjectModelClass for this class. + */ Collection<ObjectModelClass> getSpecialisations(); /** - * Returns all known direct specialized classes for this class for the specified discriminator. - * @param discriminator discriminator to get specialisations - * @return a Collection containing all known direct specialized ObjectModelClass for this class for the specified discriminator. - */ + * Returns all known direct specialized classes for this class for the + * specified discriminator. + * @param discriminator discriminator to get specialisations + * @return a Collection containing all known direct specialized + * ObjectModelClass for this class for the specified discriminator. + */ Collection<ObjectModelClass> getSpecialisations(String discriminator); /** - * Returns whether this class is abstract or not. - * - * @return a boolean indicating whether this class is abstract or not. - */ + * Returns whether this class is abstract or not. + * + * @return a boolean indicating whether this class is abstract or not. + */ boolean isAbstract(); // /** @@ -91,13 +93,13 @@ // boolean isInner(); /** - * Returns all operations defined on all Super class extended by this - * classifier, directly or indirectly. and all interface implemented by the - * super class. - * @param distinct if this boolean is true only distinct operation - * are add to list. - * @return a Collection of ObjectModelOperation - */ + * Returns all operations defined on all Super class extended by this + * classifier, directly or indirectly. and all interface implemented by the + * super class. + * @param distinct if this boolean is true only distinct operation + * are add to list. + * @return a Collection of ObjectModelOperation + */ Collection<ObjectModelOperation> getAllSuperclassOperations(boolean distinct); } //ObjectModelClass