/branches/v2_0_0_prep/libraries/libTools/src/org/gvsig/tools/persistence/PersistentState.java - Diff - Application: gvSIG desktop - gvSIG

Revision 29956 branches/v2_0_0_prep/libraries/libTools/src/org/gvsig/tools/persistence/PersistentState.java

     import java.io.Reader;
     import java.io.Writer;
     import java.util.ArrayList;
     import java.util.HashMap;
     import java.util.HashSet;
     import java.util.Iterator;
     import java.util.List;
     import java.util.Map;
     import java.util.Set;
     public interface PersistentState {
     	/**
-...
     	/**
     	 * Gets an <code>int</code> property.
     	 * @param name The name of the property to get
+    	 *
+    	 *
     	 * @param name
     	 *            The name of the property to get
+    	 *
     	 * @return The <code>int</code> property associated to the provided name
     	 * @throws PersistenceValueNotFoundException
     	 * @throws PersistenceException
     	 */
     	public int getInt(String name) throws PersistenceValueNotFoundException;
     	public int getInt(String name) throws PersistenceException;
     	/**
     	 * Gets an <code>long</code> property.
     	 * @param name The name of the property to get
+    	 *
+    	 *
     	 * @param name
     	 *            The name of the property to get
+    	 *
     	 * @return The <code>long</code> property associated to the provided name
     	 * @throws PersistenceValueNotFoundException
     	 * @throws PersistenceException
     	 */
     	public long getLong(String name) throws PersistenceValueNotFoundException;
     	public long getLong(String name) throws PersistenceException;
     	/**
     	 * Gets a <code>double</code> property.
     	 * @param name The name of the property to get
+    	 *
+    	 *
     	 * @param name
     	 *            The name of the property to get
+    	 *
     	 * @return The <code>double</code> property associated to the provided name
     	 * @throws PersistenceValueNotFoundException
     	 * @throws PersistenceException
     	 */
     	public double getDouble(String name)
     			throws PersistenceValueNotFoundException;
     			throws PersistenceException;
     	/**
     	 * Gets a <code>float</code> property.
     	 * @param name The name of the property to get
+    	 *
+    	 *
     	 * @param name
     	 *            The name of the property to get
+    	 *
     	 * @return The <code>float</code> property associated to the provided name
     	 * @throws PersistenceValueNotFoundException
     	 * @throws PersistenceException
     	 */
     	public float getFloat(String name) throws PersistenceValueNotFoundException;
     	public float getFloat(String name) throws PersistenceException;
     	/**
     	 * Gets a <code>boolean</code> property.
     	 * @param name The name of the property to get
+    	 *
+    	 *
     	 * @param name
     	 *            The name of the property to get
+    	 *
     	 * @return The <code>boolean</code> property associated to the provided name
     	 * @throws PersistenceValueNotFoundException
     	 * @throws PersistenceException
     	 */
     	public boolean getBoolean(String name)
     			throws PersistenceValueNotFoundException;
     			throws PersistenceException;
     	/**
     	 * Gets a <code>String</code> property.
     	 * @param name The name of the property to get
+    	 *
+    	 *
     	 * @param name
     	 *            The name of the property to get
+    	 *
     	 * @return The <code>String</code> property associated to the provided name
     	 * @throws PersistenceValueNotFoundException
     	 * @throws PersistenceException
     	 */
     	public String getString(String name)
     			throws PersistenceValueNotFoundException;
     			throws PersistenceException;
     	/**
     	 * Gets an <code>Object</code> property.
     	 * @param name The name of the property to get
+    	 *
+    	 *
     	 * @param name
     	 *            The name of the property to get
+    	 *
     	 * @return The <code>Object</code> property associated to the provided name
     	 * @throws PersistenceValueNotFoundException
+    	 *
     	 * @throws PersistenceException
     	 */
     	public Object get(String name) throws PersistenceValueNotFoundException,
     			PersistenceException;
     	public Object get(String name) throws PersistenceException;
     	/**
     	 * <p>Gets an <code>Iterator</code> property.</p>
+    	 *
     	 * @param name The name of the property to get
+    	 *
     	 * @return The <code>Iterator</code> property associated to the provided name
     	 * @throws PersistenceValueNotFoundException
     	 * @throws PersistenceException
     	 * <p>
     	 * Gets an <code>Iterator</code> over properties of types {@link List},
     	 * {@link Set} or {@link Map}.
     	 * </p>
+    	 *
     	 * @param name
     	 *            The name of the property to get
+    	 *
     	 * @return The <code>Iterator</code> associated to the property value of
     	 *         provided name
     	 * @throws PersistenceException
     	 */
     	public Iterator getIterator(String name) throws PersistenceValueNotFoundException, PersistenceException;
     	public Iterator getIterator(String name) throws PersistenceException;
     	/**
     	 * <p>Sets a property of type String.</p>
+    	 *
+    	 *
     	 * @param name The name of the property to store
     	 * @param it The String object to be stored in the state.
+    	 *
+    	 *
     	 * @throws PersistenceException
     	 */
     	public void set(String name, String value);
     	public void set(String name, String value) throws PersistenceException;
     	/**
     	 * <p>Sets a property of type int.</p>
+    	 *
+    	 *
     	 * @param name The name of the property to store
     	 * @param it The int value to be stored in the state.
+    	 *
+    	 *
     	 * @throws PersistenceException
     	 */
     	public void set(String name, int value);
     	public void set(String name, int value) throws PersistenceException;
     	/**
     	 * <p>Sets a property of type long.</p>
+    	 *
+    	 *
     	 * @param name The name of the property to store
     	 * @param it The long value to be stored in the state.
+    	 *
+    	 *
     	 * @throws PersistenceException
     	 */
     	public void set(String name, long value);
     	public void set(String name, long value) throws PersistenceException;
     	/**
     	 * <p>Sets a property of type double.</p>
+    	 *
+    	 *
     	 * @param name The name of the property to store
     	 * @param it The double value to be stored in the state.
+    	 *
+    	 *
     	 * @throws PersistenceException
     	 */
     	public void set(String name, double value);
     	public void set(String name, double value) throws PersistenceException;
     	/**
     	 * <p>Sets a property of type float.</p>
+    	 *
+    	 *
     	 * @param name The name of the property to store
     	 * @param it The float value to be stored in the state.
+    	 *
+    	 *
     	 * @throws PersistenceException
     	 */
     	public void set(String name, float value);
     	public void set(String name, float value) throws PersistenceException;
     	/**
     	 * <p>Sets a property of type boolean.</p>
+    	 *
+    	 *
     	 * @param name The name of the property to store
     	 * @param it The boolean value to be stored in the state.
+    	 *
+    	 *
     	 * @throws PersistenceException
     	 */
     	public void set(String name, boolean value);
     	public void set(String name, boolean value) throws PersistenceException;
     	/**
     	 * <p>Sets a property of type Persistent.</p>
+    	 *
+    	 *
     	 * @param name The name of the property to store
     	 * @param it The Persistent object to be stored in the state.
+    	 *
+    	 *
     	 * @throws PersistenceException
     	 */
     	public void set(String name, Persistent obj)
     			throws PersistenceException;
     	/**
     	 * <p>Sets a property of type Object. Only the following types can be
     	 * stored: Persistent, PersistentState, Iterator, Boolean, Integer, Long,
     	 * Float, Double or String.</p>
+    	 *
     	 * @param name The name of the property to store
     	 * @param it The object to be stored in the state.
+    	 *
     	 * Sets a property of type Object. Only the following types can be stored:
     	 * <ul>
     	 * <li> {@link Persistent}</li>
     	 * <li> {@link Boolean}</li>
     	 * <li> {@link Integer}</li>
     	 * <li> {@link Long}</li>
     	 * <li> {@link Float}</li>
     	 * <li> {@link Double}</li>
     	 * <li> {@link String}</li>
     	 * <li> {@link List} <i>({@link #get(String)} return an {@link ArrayList}
     	 * instance after {@link #load(Reader)}) </i></li>
     	 * <li> {@link Set} <i>({@link #get(String)} return a {@link HashSet}
     	 * instance after {@link #load(Reader)}) </i></li>
     	 * <li> {@link Map} <i>({@link #get(String)} return a {@link HashMap}
     	 * instance after {@link #load(Reader)}) </i></li>
+    	 *
     	 * @param name
     	 *            The name of the property to store
     	 * @param obj
     	 *            The object to be stored in the state.
+    	 *
     	 * @throws PersistenceException
     	 */
     	public void set(String name, Object obj)
     			throws PersistenceException;
     	/**
     	 * <p>Sets a property of type Iterator. This method is useful
     	 * to store arrays or lists.</p>
+    	 *
     	 * @param name The name of the property to store
     	 * @param it The iterator to be stored in the state.
+    	 *
     	 * <p>
     	 * Sets a property of type {@link List} filled with the values provided by a
     	 * {@link Iterator}
     	 * </p>
+    	 *
     	 * @param name
     	 *            The name of the property to store
     	 * @param it
     	 *            The iterator to get values to store in the list property.
+    	 *
     	 * @throws PersistenceException
     	 */
     	public void set(String name, Iterator it)
-...
     	/**
     	 * <p>Gets an iterator over the names of the properties contained
     	 * in this PersistentState.</p>
+    	 *
+    	 *
     	 * @return An iterator which provides the name of all the
     	 * properties contained in this state.
     	 */
-...
     	 * <p>De-serializes the data read from the provided <code>reader</code>. Depending
     	 * on the implementation the serialized data may have different formats, such as XML or
     	 * binary data.</p>
+    	 *
+    	 *
     	 * <p>Note that a particular implementation will only be able to
     	 * de-serialize data which has been serialized by the same
     	 * implementation.</p>
-...
     	 * @param reader
     	 */
     	public void load(Reader reader) throws PersistenceException;
     	/**
     	 * Informs that a property is set or not.
+    	 *
     	 * @param name
     	 * @return
     	 */
     	public boolean hasValue(String name);
+    }

Also available in: Unified diff