Author: echatellier Date: 2011-07-05 18:24:44 +0200 (Tue, 05 Jul 2011) New Revision: 1058 Url: http://nuiton.org/repositories/revision/wikitty/1058 Log: Add javadoc. Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/entities/BusinessEntityImpl.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/entities/Wikitty.java Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/entities/BusinessEntityImpl.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/entities/BusinessEntityImpl.java 2011-07-05 16:07:49 UTC (rev 1057) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/entities/BusinessEntityImpl.java 2011-07-05 16:24:44 UTC (rev 1058) @@ -5,7 +5,7 @@ * $Id$ * $HeadURL$ * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2011 CodeLutin, Benjamin Poussin, 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,7 +28,6 @@ import java.beans.PropertyChangeSupport; import java.util.Collection; import java.util.Collections; -import org.apache.commons.beanutils.BeanUtils; import org.nuiton.wikitty.WikittyException; import org.nuiton.wikitty.WikittyUtil; Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/entities/Wikitty.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/entities/Wikitty.java 2011-07-05 16:07:49 UTC (rev 1057) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/entities/Wikitty.java 2011-07-05 16:24:44 UTC (rev 1058) @@ -5,7 +5,7 @@ * $Id$ * $HeadURL$ * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2011 CodeLutin, Benjamin Poussin, 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 @@ -33,21 +33,53 @@ import java.util.Map; import java.util.Set; +/** + * Wikitty object, containing data as map. + * + * @author chatellier + * @version $Revision$ + * + * Last update : $Date$ + * By : $Author$ + */ public interface Wikitty extends Cloneable, Serializable { + /** + * Add property change listener. + * + * @param listener listener to add + */ void addPropertyChangeListener(PropertyChangeListener listener); + /** + * Remove property change listener. + * + * @param listener listener to remove + */ void removePropertyChangeListener(PropertyChangeListener listener); + /** + * Add property change listener on property. + * + * @param propertyName property to listen + * @param listener listener to add + */ void addPropertyChangeListener(String propertyName, PropertyChangeListener listener); + /** + * Remove property change listener on property. + * + * @param propertyName property to listen + * @param listener listener to remove + */ void removePropertyChangeListener(String propertyName, PropertyChangeListener listener); /** * Replace all field of current wikitty with field found in w. - * This two wikitty must have same id + * This two wikitty must have same id. + * * @param w wikitty where we take information */ void replaceWith(Wikitty w); @@ -59,31 +91,64 @@ */ void replaceWith(Wikitty w, boolean force); + /** + * Get wikkity id. + * + * @return wikytty id + */ String getId(); + /** + * Return {@code true} is wikitty is deleted. + * + * @return {@code true} is wikitty is deleted + */ boolean isDeleted(); + /** + * Return deletion date. + * + * @return deletion date or {@code null} if not deleted + */ Date getDeleteDate(); /** - * Server only used - * @param delete + * Set deletion date. + * + * Server only used. + * + * @param date deletion date */ - void setDeleteDate(Date delete); + void setDeleteDate(Date date); + /** + * Add new extension. + * + * @param ext extension to add + */ void addExtension(WikittyExtension ext); + /** + * Add multiples extensions. + * + * @param exts extensions to add + */ void addExtension(List<WikittyExtension> exts); - /** check that the wikitty has a metaExtension about a given extension. + /** + * Check that the wikitty has a metaExtension about a given extension. + * * @param metaExtensionName the metaExtension to be checked * @param extensionName an extension already added to the wikitty + * @return {@code true} if current wikitty has meta extension * @since 2.2.0 */ boolean hasMetaExtension(String metaExtensionName, String extensionName); - /** add a meta-extension about the given extension to this wikitty. + /** + * Add a meta-extension about the given extension to this wikitty. + * * @param metaExtension the metaExtension to add * @param extension an extension already added to the wikitty * @since 2.1 @@ -91,18 +156,38 @@ void addMetaExtension(WikittyExtension metaExtension, WikittyExtension extension); - - /** add a meta-extension on the given extension to this wikitty. + /** + * Add a meta-extension on the given extension to this wikitty. + * * @param metaExtension the metaExtension to add * @param extensionFqn the name of the extension already added to the wikitty * @since 2.1 */ void addMetaExtension(WikittyExtension metaExtension, String extensionFqn); + /** + * Check if current wikitty has extension. + * + * @param extName extension name to check + * @return {@code true} if current wikitty has extension. + */ boolean hasExtension(String extName); + /** + * Check if current wikitty has requested field. + * + * @param extName extension name + * @param fieldName field name on extension + * @return {@code true} if wikitty has field + */ boolean hasField(String extName, String fieldName); + /** + * Check if current wikitty has requested fully qualified field. + * + * @param fqfieldName fully qualified field name + * @return {@code true} if wikitty has field + */ boolean hasField(String fqfieldName); WikittyExtension getExtension(String ext); @@ -115,14 +200,29 @@ boolean recursively); /** - * return field type for the given fieldName. + * Return field type for the given fieldName. + * * @param fqfieldName fully qualified fieldName extension.fieldname * @return field type */ FieldType getFieldType(String fqfieldName); + /** + * Set field value. + * + * @param ext extension + * @param fieldName field name + * @param value + */ void setField(String ext, String fieldName, Object value); + /** + * Get field value. + * + * @param ext extension name + * @param fieldName field name + * @return + */ Object getFieldAsObject(String ext, String fieldName); byte[] getFieldAsBytes(String ext, String fieldName);