Mercurial > illumos > git > illumos-joyent

changeset 25628:42181203a6d7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
13396 PoolsExecption typo in resource pools javadoc Reviewed by: Toomas Soome <tsoome@me.com> Approved by: Robert Mustacchi <rm@fingolfin.org>
author Peter Tribble <peter.tribble@gmail.com>
date Mon, 28 Dec 2020 20:32:09 +0000
parents fc9802b8f6e3
children 2dae6825d710
files usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Component.java usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Configuration.java usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Element.java usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Pool.java usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Property.java usr/src/cmd/pools/poold/com/sun/solaris/service/pools/PropertyWalk.java usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Resource.java usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Value.java
diffstat 8 files changed, 55 insertions(+), 67 deletions(-) [+]
line wrap: on
line diff
--- a/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Component.java	Mon Apr 13 09:59:39 2020 +0300
+++ b/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Component.java	Mon Dec 28 20:32:09 2020 +0000
@@ -23,8 +23,6 @@
  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
  * Use is subject to license terms.
  *
- *ident	"%Z%%M%	%I%	%E% SMI"
- *
  */
 
 package com.sun.solaris.service.pools;
@@ -147,7 +145,7 @@
 	 * Return the pointer to this component as an element.
 	 *
 	 * @return The pointer to the native component which this object wraps.
-	 * @throws PoolsExecption If there is an error converting the native
+	 * @throws PoolsException If there is an error converting the native
 	 * component pointer to a native elem pointer.
 	 */
 	protected long getElem() throws PoolsException
--- a/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Configuration.java	Mon Apr 13 09:59:39 2020 +0300
+++ b/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Configuration.java	Mon Dec 28 20:32:09 2020 +0000
@@ -23,8 +23,6 @@
  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
  * Use is subject to license terms.
  *
- *ident	"%Z%%M%	%I%	%E% SMI"
- *
  */
 
 package com.sun.solaris.service.pools;
@@ -173,7 +171,7 @@
 	/**
 	 * Remove the configuration.
 	 *
-	 * @throws PoolsExecption If the removal fails.
+	 * @throws PoolsException If the removal fails.
 	 */
 	public void remove() throws PoolsException
 	{
@@ -187,7 +185,7 @@
 	 * made since the last commit or (if there are no commits) since the
 	 * configuration was opened.
 	 *
-	 * @throws PoolsExecption If the rollback fails.
+	 * @throws PoolsException If the rollback fails.
 	 */
 	public void rollback() throws PoolsException
 	{
@@ -201,7 +199,7 @@
 	 * was last committed (or opened if there have been no prior commits)
 	 * permanent.
 	 *
-	 * @throws PoolsExecption If the commit fails.
+	 * @throws PoolsException If the commit fails.
 	 */
 	public void commit(int active) throws PoolsException
 	{
@@ -216,7 +214,7 @@
 	 *
 	 * @param location The location of the export.
 	 * @param format The format of the export.
-	 * @throws PoolsExecption If the export fails.
+	 * @throws PoolsException If the export fails.
 	 */
 	public void export(String location, int format) throws PoolsException
 	{
@@ -230,7 +228,7 @@
 	 * configuration satisfies the supplied validation level.
 	 *
 	 * @param level The desired level of validation.
-	 * @throws PoolsExecption If the validation fails.
+	 * @throws PoolsException If the validation fails.
 	 */
 	public void validate(int level) throws PoolsException
 	{
@@ -243,7 +241,7 @@
 	 * Update the configuration, ensuring that the current state of the
 	 * configuration reflects that of the kernel.
 	 *
-	 * @throws PoolsExecption If the update fails.
+	 * @throws PoolsException If the update fails.
 	 * @return a bitmap of the changed types.
 	 */
 	public int update() throws PoolsException
@@ -255,7 +253,7 @@
 	 * Create a pool with the supplied name.
 	 *
 	 * @param name The name of the PoolInternal.
-	 * @throws PoolsExecption If the pool creation fails.
+	 * @throws PoolsException If the pool creation fails.
 	 * @return a pool with the supplied name.
 	 */
 	public Pool createPool(String name) throws PoolsException
@@ -286,7 +284,7 @@
 	 * Get the pool with the supplied name.
 	 *
 	 * @param name The name of the pool to be found.
-	 * @throws PoolsExecption If the pool cannot be located.
+	 * @throws PoolsException If the pool cannot be located.
 	 * @return a pool with the supplied name.
 	 */
 	public Pool getPool(String name) throws PoolsException
@@ -304,13 +302,13 @@
 			elements.put(p.getKey(), p);
 			return (p);
 		}
-	}	
+	}
 
 	/**
 	 * Get the proxy for the pool with the supplied name.
 	 *
 	 * @param name The name of the pool to be found.
-	 * @throws PoolsExecption If the pool cannot be located.
+	 * @throws PoolsException If the pool cannot be located.
 	 * @return the proxy for the pool with the supplied name.
 	 */
 	long checkPool(String name) throws PoolsException
@@ -322,14 +320,14 @@
 			throw new PoolsException();
 		}
 		return (aPool);
-	}	
+	}
 
 	/**
 	 * Get a list of pools which match the supplied selection criteria
 	 * in values.
 	 *
 	 * @param values A list of values to be used to qualify the search.
-	 * @throws PoolsExecption If there is an error executing the query.
+	 * @throws PoolsException If there is an error executing the query.
 	 * @return a list of pools which match the supplied criteria
 	 */
 	public List getPools(List values) throws PoolsException
@@ -350,13 +348,13 @@
 			    ((Long)pools.get(i)).longValue()));
 		return (aList);
 	}
-	
+
 	/**
 	 * Create a resource with the supplied type and name.
 	 *
 	 * @param type The type of the resource.
 	 * @param name The name of the resource.
-	 * @throws PoolsExecption If the resource creation fails.
+	 * @throws PoolsException If the resource creation fails.
 	 * @return a resource of the supplied type and name.
 	 */
 	public Resource createResource(String type, String name)
@@ -391,7 +389,7 @@
 	 *
 	 * @param type The type of the resource to be found.
 	 * @param name The name of the resource to be found.
-	 * @throws PoolsExecption If the resource cannot be located.
+	 * @throws PoolsException If the resource cannot be located.
 	 * @return a resource with the supplied name.
 	 */
 	public Resource getResource(String type, String name)
@@ -410,7 +408,7 @@
 			elements.put(r.getKey(), r);
 			return (r);
 		}
-	}	
+	}
 
 	/**
 	 * Get the proxy for the resource with the supplied type and
@@ -418,7 +416,7 @@
 	 *
 	 * @param type The type of the resource to be found.
 	 * @param name The name of the resource to be found.
-	 * @throws PoolsExecption If the resource cannot be located.
+	 * @throws PoolsException If the resource cannot be located.
 	 * @return the proxy for the resource with the supplied name.
 	 */
 	long checkResource(String type, String name) throws PoolsException
@@ -430,14 +428,14 @@
 			throw new PoolsException();
 		}
 		return (res);
-	}	
+	}
 
 	/**
 	 * Get a list of resources which match the supplied selection criteria
 	 * in values.
 	 *
 	 * @param values A list of values to be used to qualify the search.
-	 * @throws PoolsExecption If there is an error executing the query.
+	 * @throws PoolsException If there is an error executing the query.
 	 * @return a list of resources which match the supplied criteria
 	 */
 	public List getResources(List values) throws PoolsException
@@ -464,7 +462,7 @@
 	 *
 	 * @param type The type of the component to be found.
 	 * @param sys_id The sys_id of the component to be found.
-	 * @throws PoolsExecption If the component cannot be located.
+	 * @throws PoolsException If the component cannot be located.
 	 * @return a component with the supplied name.
 	 */
 	public Component getComponent(String type, long sys_id)
@@ -482,14 +480,14 @@
 		if (comps.size() != 1)
 			throw new PoolsException();
 		return ((Component) comps.get(0));
-	}	
+	}
 
 	/**
 	 * Get the component proxy with the supplied type and sys_id.
 	 *
 	 * @param type The type of the component to be found.
 	 * @param sys_id The sys_id of the component to be found.
-	 * @throws PoolsExecption If the component cannot be located.
+	 * @throws PoolsException If the component cannot be located.
 	 * @return a component with the supplied name.
 	 */
 	long checkComponent(String type, long sys_id)
@@ -507,20 +505,20 @@
 		if (comps.size() != 1)
 			throw new PoolsException();
 		return (((Long)comps.get(0)).longValue());
-	}	
+	}
 
 	/**
 	 * Get a list of components which match the supplied selection criteria
 	 * in values.
 	 *
 	 * @param values A list of values to be used to qualify the search.
-	 * @throws PoolsExecption If there is an error executing the query.
+	 * @throws PoolsException If there is an error executing the query.
 	 * @return a list of components which match the supplied criteria
 	 */
 	public List getComponents(List values) throws PoolsException
 	{
 		List components;
-		
+
 		if ((components = PoolInternal.pool_query_components(getConf(),
 		    values)) == null) {
 			if (PoolInternal.pool_error() ==
@@ -556,7 +554,7 @@
 				throw new PoolsException();
 			long sys_id = idValue.getLong();
 			idValue.close();
-				
+
 			if (elements.containsKey(type + "." + sys_id))
 				aList.add((Component)elements.get(type + "." +
 					  sys_id));
@@ -573,7 +571,7 @@
 	 * selection criteria in values.
 	 *
 	 * @param values A list of values to be used to qualify the search.
-	 * @throws PoolsExecption If there is an error executing the query.
+	 * @throws PoolsException If there is an error executing the query.
 	 * @return a list of component proxies which match the
 	 * supplied criteria
 	 */
@@ -649,13 +647,13 @@
 	{
 		return name.hashCode();
 	}
-	
+
 	/**
 	 * Return the pointer to this configuration as an element.
 	 *
 	 * @return The pointer to the native configuration which this object
 	 * wraps.
-	 * @throws PoolsExecption If there is an error converting the native
+	 * @throws PoolsException If there is an error converting the native
 	 * configuration pointer to a native elem pointer.
 	 */
 	protected long getElem() throws PoolsException
@@ -668,7 +666,7 @@
 	}
 
 	/**
-	 * Return the anme of the configuration.
+	 * Return the name of the configuration.
 	 */
 	String getName()
 	{
--- a/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Element.java	Mon Apr 13 09:59:39 2020 +0300
+++ b/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Element.java	Mon Dec 28 20:32:09 2020 +0000
@@ -84,7 +84,7 @@
 	 * Get the property with the supplied name.
 	 *
 	 * @param name The name of the property to be retrieved.
-	 * @throws PoolsExecption If there is an error accessing the property.
+	 * @throws PoolsException If there is an error accessing the property.
 	 * @return a value containing the property details.
 	 */
         private Value getProperty(String name) throws PoolsException
@@ -113,7 +113,7 @@
 	 *
 	 * @param name The name of the property to be retrieved.
 	 * @param proxy The proxy item used to retrieve the property.
-	 * @throws PoolsExecption If there is an error accessing the property.
+	 * @throws PoolsException If there is an error accessing the property.
 	 * @return a value containing the property details.
 	 */
         protected Value getProperty(String name, long proxy)
@@ -143,7 +143,7 @@
 	 *
 	 * @param name The name of the property to be updated.
 	 * @param value The value of the property to be updated.
-	 * @throws PoolsExecption If there is an error accessing the property.
+	 * @throws PoolsException If there is an error accessing the property.
 	 */
         public void putProperty(String name, Value value) throws PoolsException
 	{
@@ -156,7 +156,7 @@
 	 * Remove the element property with the supplied name.
 	 *
 	 * @param name The name of the property to be removed.
-	 * @throws PoolsExecption If there is an error removing the property.
+	 * @throws PoolsException If there is an error removing the property.
 	 */
         public void rmProperty(String name) throws PoolsException
 	{
@@ -259,7 +259,7 @@
 	 * @param elem The element to whom the property belongs.
 	 * @param val The value representing the current element.
 	 * @param user User supplied data, provided when the walk is invoked.
-	 * @throws PoolsExecption If there is an error walking the property.
+	 * @throws PoolsException If there is an error walking the property.
 	 * @return 0 to continue the walk, anything else to terminate it.
 	 */
 	public int walk(Element elem, Value val, Object user)
@@ -275,7 +275,7 @@
 	 * Return the pointer to this subtype as an element.
 	 *
 	 * @return The pointer to the native subtype which this object wraps.
-	 * @throws PoolsExecption If there is an error converting the native
+	 * @throws PoolsException If there is an error converting the native
 	 * subtype pointer to a native elem pointer.
 	 */
 	protected abstract long getElem() throws PoolsException;
@@ -286,7 +286,7 @@
 	 * @param handler The object which will receive the callbacks.
 	 * @param user Data supplied by the user for use in the callback.
 	 * @return 0 for a successful walk, else 1.
-	 * @throws PoolsExecption If there is an error during the walk.
+	 * @throws PoolsException If there is an error during the walk.
 	 */
 	public int walkProperties(PropertyWalk handler, Object user)
 	    throws PoolsException
--- a/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Pool.java	Mon Apr 13 09:59:39 2020 +0300
+++ b/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Pool.java	Mon Dec 28 20:32:09 2020 +0000
@@ -23,8 +23,6 @@
  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
  * Use is subject to license terms.
  *
- *ident	"%Z%%M%	%I%	%E% SMI"
- *
  */
 
 package com.sun.solaris.service.pools;
@@ -108,7 +106,7 @@
 	 * searched.
 	 *
 	 * @param values A list of values to be used to qualify the search.
-	 * @throws PoolsExecption If there is an error executing the query.
+	 * @throws PoolsException If there is an error executing the query.
 	 * @return a list of resources which match the supplied criteria
 	 */
 	public List getResources(List values) throws PoolsException
@@ -195,7 +193,7 @@
 	 * Return the pointer to this pool as an element.
 	 *
 	 * @return The pointer to the native pool which this object wraps.
-	 * @throws PoolsExecption If there is an error converting the native
+	 * @throws PoolsException If there is an error converting the native
 	 * pool pointer to a native elem pointer.
 	 */
 	protected long getElem() throws PoolsException
--- a/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Property.java	Mon Apr 13 09:59:39 2020 +0300
+++ b/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Property.java	Mon Dec 28 20:32:09 2020 +0000
@@ -23,15 +23,13 @@
  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
  * Use is subject to license terms.
  *
- *ident	"%Z%%M%	%I%	%E% SMI"
- *
  */
 
 package com.sun.solaris.service.pools;
 
 /**
  * The <code>Property</code> interface specifies the contract between
- * a pools configuration element and it's properties. This interface
+ * a pools configuration element and its properties. This interface
  * must be implemented by all pools configuration elements to ensure that
  * properties can be manipulated.
  */
@@ -41,7 +39,7 @@
 	 * Get a property with the supplied name.
 	 *
 	 * @param name The name of the property to be retrieved.
-	 * @throws PoolsExecption If there is an error accessing the property.
+	 * @throws PoolsException If there is an error accessing the property.
 	 */
 	public boolean getBoolProperty(String name) throws PoolsException;
 
@@ -49,7 +47,7 @@
 	 * Get a property with the supplied name.
 	 *
 	 * @param name The name of the property to be retrieved.
-	 * @throws PoolsExecption If there is an error accessing the property.
+	 * @throws PoolsException If there is an error accessing the property.
 	 */
 	public double getDoubleProperty(String name) throws PoolsException;
 
@@ -57,7 +55,7 @@
 	 * Get a property with the supplied name.
 	 *
 	 * @param name The name of the property to be retrieved.
-	 * @throws PoolsExecption If there is an error accessing the property.
+	 * @throws PoolsException If there is an error accessing the property.
 	 */
 	public long getLongProperty(String name) throws PoolsException;
 
@@ -65,7 +63,7 @@
 	 * Get a property with the supplied name.
 	 *
 	 * @param name The name of the property to be retrieved.
-	 * @throws PoolsExecption If there is an error accessing the property.
+	 * @throws PoolsException If there is an error accessing the property.
 	 */
 	public String getStringProperty(String name) throws PoolsException;
 
@@ -74,7 +72,7 @@
 	 *
 	 * @param name The name of the property to be updated.
 	 * @param value The value of the property to be updated.
-	 * @throws PoolsExecption If there is an error accessing the property.
+	 * @throws PoolsException If there is an error accessing the property.
 	 */
 	public void putProperty(String name, Value value) throws PoolsException;
 
@@ -82,7 +80,7 @@
 	 * Remove the property with the supplied name.
 	 *
 	 * @param name The name of the property to be removed.
-	 * @throws PoolsExecption If there is an error removing the property.
+	 * @throws PoolsException If there is an error removing the property.
 	 */
 	public void rmProperty(String name) throws PoolsException;
 }
--- a/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/PropertyWalk.java	Mon Apr 13 09:59:39 2020 +0300
+++ b/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/PropertyWalk.java	Mon Dec 28 20:32:09 2020 +0000
@@ -23,8 +23,6 @@
  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
  * Use is subject to license terms.
  *
- *ident	"%Z%%M%	%I%	%E% SMI"
- *
  */
 
 package com.sun.solaris.service.pools;
@@ -40,12 +38,12 @@
 
 public interface PropertyWalk {
 	/**
-	 * Walk all properties of the invoking object, calling the 
+	 * Walk all properties of the invoking object, calling the
 	 *
 	 * @param elem The element to whom the property belongs.
 	 * @param val The value representing the current element.
 	 * @param user User supplied data, provided when the walk is invoked.
-	 * @throws PoolsExecption If there is an error walking the property.
+	 * @throws PoolsException If there is an error walking the property.
 	 * @return 0 to continue the walk, anything else to terminate it.
 	 */
 	public int walk(Element elem, Value val, Object user)
--- a/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Resource.java	Mon Apr 13 09:59:39 2020 +0300
+++ b/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Resource.java	Mon Dec 28 20:32:09 2020 +0000
@@ -22,8 +22,6 @@
 /*
  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
  * Use is subject to license terms.
- *
- *ident	"%Z%%M%	%I%	%E% SMI"
  */
 
 package com.sun.solaris.service.pools;
@@ -69,7 +67,7 @@
 	}
 
         /**
-         * Returns a pointer to the native resouce represented by this resource
+         * Returns a pointer to the native resource represented by this resource
 	 * object.
          *
 	 * @throws PoolsException If the pool cannot be located.
@@ -96,7 +94,7 @@
 		    donor.getResource(), getResource(), qty) !=
 		    PoolInternal.PO_SUCCESS)
 			throw new PoolsException();
-	}		
+	}
 
         /**
          * Transfer the specified resource components from the donor to this
@@ -114,7 +112,7 @@
 		    donor.getResource(), getResource(), components) !=
 		    PoolInternal.PO_SUCCESS)
 			throw new PoolsException();
-	}		
+	}
 
 	/**
 	 * Get a list of components which match the supplied selection
@@ -122,7 +120,7 @@
 	 * this resource are searched.
 	 *
 	 * @param values A list of values to be used to qualify the search.
-	 * @throws PoolsExecption If there is an error executing the query.
+	 * @throws PoolsException If there is an error executing the query.
 	 * @return a list of components which match the supplied criteria
 	 */
 	public List getComponents(List values) throws PoolsException
@@ -211,7 +209,7 @@
 	 * Return the pointer to this resource as an element.
 	 *
 	 * @return The pointer to the native resource which this object wraps.
-	 * @throws PoolsExecption If there is an error converting the native
+	 * @throws PoolsException If there is an error converting the native
 	 * resource pointer to a native elem pointer.
 	 */
 	protected long getElem() throws PoolsException
--- a/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Value.java	Mon Apr 13 09:59:39 2020 +0300
+++ b/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/Value.java	Mon Dec 28 20:32:09 2020 +0000
@@ -219,7 +219,7 @@
 	 * Set this value to take the supplied string value.
 	 *
 	 * @param value The value to which this value should be set.
-	 * @throws PoolsExecption If the setting of the value fails.
+	 * @throws PoolsException If the setting of the value fails.
 	 */
 	public void setValue(String value) throws PoolsException
 	{