Author: painter
Date: Wed Nov 28 22:01:47 2018
New Revision: 1847680
URL: http://svn.apache.org/viewvc?rev=1847680&view=rev
Log:
Clean up javadoc warnings on src, test still has quite a few
Modified:
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/component/AvalonServiceComponentImpl.java
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/component/ServiceComponentImpl.java
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/configuration/ComponentConfigurationPropertiesResolverBaseImpl.java
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/container/ServiceContainerImpl.java
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/context/AvalonToYaafiContextMapper.java
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/util/InputStreamLocator.java
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/service/shutdown/ShutdownEntry.java
Modified:
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/component/AvalonServiceComponentImpl.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/component/AvalonServiceComponentImpl.java?rev=1847680&r1=1847679&r2=1847680&view=diff
==============================================================================
---
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/component/AvalonServiceComponentImpl.java
(original)
+++
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/component/AvalonServiceComponentImpl.java
Wed Nov 28 22:01:47 2018
@@ -71,8 +71,8 @@ public class AvalonServiceComponentImpl
// Service Component Lifecycle Implementation
/////////////////////////////////////////////////////////////////////////
- /**
- * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponent#incarnate()
+ /* (non-Javadoc)
+ * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentImpl#incarnateInstance()
*/
protected void incarnateInstance() throws Exception
{
@@ -139,8 +139,8 @@ public class AvalonServiceComponentImpl
}
}
- /**
- * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponent#reconfigure()
+ /* (non-Javadoc)
+ * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentImpl#reconfigure()
*/
public void reconfigure() throws Exception
{
@@ -197,10 +197,9 @@ public class AvalonServiceComponentImpl
}
}
- /**
+ /* (non-Javadoc)
* Stop and dispose the service implementation.
- *
- * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponent#decommision()
+ * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentImpl#decommision()
*/
public void decommision() throws Exception
{
@@ -277,7 +276,7 @@ public class AvalonServiceComponentImpl
/**
* @see
org.apache.avalon.framework.context.Contextualizable#contextualize(org.apache.avalon.framework.context.Context)
* @param context the context to add to this service
- * @throws ContextException
+ * @throws ContextException if unable to contextualize
*/
public void contextualize(Context context) throws ContextException
{
@@ -338,6 +337,9 @@ public class AvalonServiceComponentImpl
/**
* @see
org.apache.avalon.framework.configuration.Configurable#configure(org.apache.avalon.framework.configuration.Configuration)
+ *
+ * @param configuration the configuration
+ * @throws ConfigurationException if fails to contextualize the config
*/
public void configure(Configuration configuration) throws
ConfigurationException
{
@@ -365,11 +367,11 @@ public class AvalonServiceComponentImpl
}
}
-/**
- * @see
org.apache.avalon.framework.parameters.Parameterizable#parameterize(org.apache.avalon.framework.parameters.Parameters)
- * @param parameters
- * @throws ParameterException
- */
+ /**
+ * @see
org.apache.avalon.framework.parameters.Parameterizable#parameterize(org.apache.avalon.framework.parameters.Parameters)
+ * @param parameters the parameters
+ * @throws ParameterException if unable to set the parameters
+ */
public void parameterize(Parameters parameters) throws ParameterException
{
Object rawInstance = this.getRawInstance(false);
@@ -398,6 +400,7 @@ public class AvalonServiceComponentImpl
/**
* @see org.apache.avalon.framework.activity.Initializable#initialize()
+ * @throws Exception generic exception
*/
public void initialize() throws Exception
{
@@ -427,6 +430,7 @@ public class AvalonServiceComponentImpl
/**
* @see org.apache.avalon.framework.activity.Executable#execute()
+ * @throws Exception generic exception
*/
public void execute() throws Exception
{
@@ -456,6 +460,7 @@ public class AvalonServiceComponentImpl
/**
* @see org.apache.avalon.framework.activity.Startable#start()
+ * @throws Exception generic exception
*/
public void start() throws Exception
{
@@ -485,6 +490,7 @@ public class AvalonServiceComponentImpl
/**
* @see org.apache.avalon.framework.activity.Startable#stop()
+ * @throws Exception generic exception
*/
public void stop() throws Exception
{
@@ -560,8 +566,8 @@ public class AvalonServiceComponentImpl
/**
* @see
org.apache.avalon.framework.configuration.Reconfigurable#reconfigure(org.apache.avalon.framework.configuration.Configuration)
- * @param configuration
- * @throws ConfigurationException
+ * @param configuration the configuration
+ * @throws ConfigurationException if unable to configure
*/
public void reconfigure(Configuration configuration) throws
ConfigurationException
{
Modified:
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/component/ServiceComponentImpl.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/component/ServiceComponentImpl.java?rev=1847680&r1=1847679&r2=1847680&view=diff
==============================================================================
---
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/component/ServiceComponentImpl.java
(original)
+++
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/component/ServiceComponentImpl.java
Wed Nov 28 22:01:47 2018
@@ -43,7 +43,7 @@ public abstract class ServiceComponentIm
private RoleEntry roleEntry;
/** the actual implementation class of the service component */
- private Class implementationClazz;
+ private Class<?> implementationClazz;
/** the instance of the implementation class of the service component */
private Object instance;
@@ -92,7 +92,7 @@ public abstract class ServiceComponentIm
// Service Component Lifecycle Implementation
/////////////////////////////////////////////////////////////////////////
- /**
+ /* (non-Javadoc)
* @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#loadImplemtationClass(java.lang.ClassLoader)
*/
public void loadImplemtationClass(ClassLoader classLoader)
@@ -127,7 +127,7 @@ public abstract class ServiceComponentIm
}
}
- /**
+ /* (non-Javadoc)
* @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#getInstance()
*/
public Object getInstance()
@@ -142,7 +142,7 @@ public abstract class ServiceComponentIm
return this.getRawInstance(true);
}
- /**
+ /* (non-Javadoc)
* @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#incarnate()
*/
public void incarnate() throws Exception
@@ -163,12 +163,12 @@ public abstract class ServiceComponentIm
}
}
- /**
+ /* (non-Javadoc)
* @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#reconfigure()
*/
public abstract void reconfigure() throws Exception;
- /**
+ /* (non-Javadoc)
* @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#decommision()
*/
public void decommision() throws Exception
@@ -177,7 +177,7 @@ public abstract class ServiceComponentIm
this.proxy = null;
}
- /**
+ /* (non-Javadoc)
* @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#dispose()
*/
public void dispose()
@@ -194,40 +194,40 @@ public abstract class ServiceComponentIm
this.parameters = null;
}
- /**
- * @param logger The logger to set.
+ /* (non-Javadoc)
+ * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#setLogger(org.apache.avalon.framework.logger.Logger)
*/
public void setLogger(Logger logger)
{
this.logger = logger;
}
- /**
- * @param context The context to set.
+ /* (non-Javadoc)
+ * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#setContext(org.apache.avalon.framework.context.Context)
*/
public void setContext(Context context)
{
this.context = context;
}
- /**
- * @param serviceManager The serviceManager to set.
+ /* (non-Javadoc)
+ * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#setServiceManager(org.apache.avalon.framework.service.ServiceManager)
*/
public void setServiceManager(ServiceManager serviceManager)
{
this.serviceManager = serviceManager;
}
- /**
- * @param configuration The configuration to set.
+ /* (non-Javadoc)
+ * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#setConfiguration(org.apache.avalon.framework.configuration.Configuration)
*/
public void setConfiguration(Configuration configuration)
{
this.configuration = configuration;
}
- /**
- * @param parameters The parameters to set.
+ /* (non-Javadoc)
+ * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponentLifecycle#setParameters(org.apache.avalon.framework.parameters.Parameters)
*/
public void setParameters(Parameters parameters)
{
@@ -246,7 +246,7 @@ public abstract class ServiceComponentIm
return this.getRoleEntry().isEarlyInit();
}
- /**
+ /* (non-Javadoc)
* @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponent#getName()
*/
public String getName()
@@ -254,8 +254,8 @@ public abstract class ServiceComponentIm
return this.getRoleEntry().getName();
}
- /**
- * @return Returns the roleEntry.
+ /* (non-Javadoc)
+ * @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponent#getRoleEntry()
*/
public RoleEntry getRoleEntry()
{
@@ -281,7 +281,7 @@ public abstract class ServiceComponentIm
/**
* @return Returns the implementationClazz.
*/
- public Class getImplementationClazz()
+ public Class<?> getImplementationClazz()
{
return this.implementationClazz;
}
@@ -330,7 +330,7 @@ public abstract class ServiceComponentIm
// Class implementation
/////////////////////////////////////////////////////////////////////////
- /**
+ /* (non-Javadoc)
* @see java.lang.Object#toString()
*/
public String toString()
@@ -352,9 +352,10 @@ public abstract class ServiceComponentIm
/**
* Create an instance of the service component implementation class
- *
- * @throws InstantiationException th
- * @throws IllegalAccessException
+ *
+ * @return instance of the service component class
+ * @throws InstantiationException if unable to instantiate
+ * @throws IllegalAccessException if unable to access
*/
protected Object createInstance()
throws InstantiationException, IllegalAccessException
@@ -371,12 +372,14 @@ public abstract class ServiceComponentIm
/**
* @see
org.apache.fulcrum.yaafi.framework.component.ServiceComponent#incarnate()
+ * @throws Exception generic exception
*/
protected abstract void incarnateInstance() throws Exception;
/**
* Get either the original service object or the dynamic proxy
*
+ * @param useProxy set to true if using a proxy
* @return Returns the raw instance, i.e. does not incarnate
* the instance.
*/
Modified:
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/configuration/ComponentConfigurationPropertiesResolverBaseImpl.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/configuration/ComponentConfigurationPropertiesResolverBaseImpl.java?rev=1847680&r1=1847679&r2=1847680&view=diff
==============================================================================
---
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/configuration/ComponentConfigurationPropertiesResolverBaseImpl.java
(original)
+++
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/configuration/ComponentConfigurationPropertiesResolverBaseImpl.java
Wed Nov 28 22:01:47 2018
@@ -141,6 +141,7 @@ public abstract class ComponentConfigura
/**
* Add the Avalon context variables.
* @param properties properties to be set
+ * @throws ContextException if context not found
*/
protected void addAvalonContext(Properties properties) throws
ContextException
{
@@ -169,6 +170,8 @@ public abstract class ComponentConfigura
/**
* Set properties from a file location
* @param fileLocation file location of properties properties to be set
+ * @return the properties
+ * @throws Exception if unable to parse the properties file
*/
protected Properties loadProperties(String fileLocation) throws Exception
{
Modified:
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/container/ServiceContainerImpl.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/container/ServiceContainerImpl.java?rev=1847680&r1=1847679&r2=1847680&view=diff
==============================================================================
---
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/container/ServiceContainerImpl.java
(original)
+++
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/container/ServiceContainerImpl.java
Wed Nov 28 22:01:47 2018
@@ -107,10 +107,10 @@ public class ServiceContainerImpl
private ServiceManager parentServiceManager;
/** The list of services instantiated */
- private List serviceList;
+ private List<ServiceComponent> serviceList;
/** The map of services used for the lookup */
- private HashMap serviceMap;
+ private HashMap<String, ServiceComponent> serviceMap;
/** The Avalon role configuration loaded by this class */
private Configuration roleConfiguration;
@@ -146,10 +146,10 @@ public class ServiceContainerImpl
private boolean hasDynamicProxies;
/** The list of interceptor services applied to all services */
- private ArrayList defaultInterceptorServiceList;
+ private ArrayList<String> defaultInterceptorServiceList;
/** The list of ServiceManagers as fallback service lookup */
- private ArrayList fallbackServiceManagerList;
+ private ArrayList<String> fallbackServiceManagerList;
/** the configuration for running the
ComponentConfigurationPropertiesResolver */
private Configuration componentConfigurationPropertiesResolverConfig;
@@ -179,14 +179,14 @@ public class ServiceContainerImpl
this.isAlreadyDisposed = false;
this.isCurrentlyDisposing = false;
- this.serviceList = new ArrayList();
- this.serviceMap = new HashMap();
+ this.serviceList = new ArrayList<ServiceComponent>();
+ this.serviceMap = new HashMap<String, ServiceComponent>();
this.applicationRootDir = new File( new File("").getAbsolutePath() );
this.tempRootDir = new File( System.getProperty("java.io.tmpdir",".")
);
- this.fallbackServiceManagerList = new ArrayList();
- this.defaultInterceptorServiceList = new ArrayList();
+ this.fallbackServiceManagerList = new ArrayList<String>();
+ this.defaultInterceptorServiceList = new ArrayList<String>();
this.disposalDelay = DISPOSAL_DELAY_DEFAULT;
this.reconfigurationDelay = RECONFIGURATION_DELAY_DEFAULT;
@@ -458,7 +458,7 @@ public class ServiceContainerImpl
// create the service implementation instances
- List currServiceList = this.createServiceComponents(
+ List<ServiceComponent> currServiceList = this.createServiceComponents(
this.roleConfiguration,
this.getLogger()
);
@@ -639,7 +639,7 @@ public class ServiceContainerImpl
public synchronized RoleEntry[] getRoleEntries()
{
ServiceComponent serviceComponent;
- List serviceList = this.getServiceList();
+ List<ServiceComponent> serviceList = this.getServiceList();
RoleEntry[] result = new RoleEntry[serviceList.size()];
for( int i=0; i<result.length; i++ )
@@ -1052,7 +1052,7 @@ public class ServiceContainerImpl
/**
* @return Returns the serviceMap.
*/
- private HashMap getServiceMap()
+ private HashMap<String, ServiceComponent> getServiceMap()
{
return this.serviceMap;
}
@@ -1063,7 +1063,7 @@ public class ServiceContainerImpl
* @param serviceList the list of available services
* @throws Exception the incarnation of a service failed
*/
- private void incarnateAll(List serviceList)
+ private void incarnateAll(List<ServiceComponent> serviceList)
throws Exception
{
ServiceComponent serviceComponent;
@@ -1164,7 +1164,7 @@ public class ServiceContainerImpl
*
* @param serviceList the list of services to decommission
*/
- private void decommissionAll(List serviceList)
+ private void decommissionAll(List<ServiceComponent> serviceList)
{
for( int i=serviceList.size()-1; i>=0; i-- )
{
@@ -1201,7 +1201,7 @@ public class ServiceContainerImpl
*
* @param serviceList the list of services to dispose
*/
- private void disposeAll(List serviceList)
+ private void disposeAll(List<ServiceComponent> serviceList)
{
for( int i=serviceList.size()-1; i>=0; i-- )
{
@@ -1241,7 +1241,7 @@ public class ServiceContainerImpl
/**
* @return The list of currently know services
*/
- private List getServiceList()
+ private List<ServiceComponent> getServiceList()
{
return this.serviceList;
}
@@ -1249,7 +1249,7 @@ public class ServiceContainerImpl
/**
* @param list The list of known services
*/
- private void setServiceList(List list)
+ private void setServiceList(List<ServiceComponent> list)
{
this.serviceList = list;
}
@@ -1271,13 +1271,13 @@ public class ServiceContainerImpl
* @return the list of service components
* @throws ConfigurationException creating the service instance failed
*/
- private List createServiceComponents(Configuration roleConfiguration,
Logger logger )
+ private List<ServiceComponent> createServiceComponents(Configuration
roleConfiguration, Logger logger )
throws ConfigurationException
{
Validate.notNull(roleConfiguration,"roleConfiguration");
Validate.notNull(logger,"logger");
- ArrayList result = new ArrayList();
+ ArrayList<ServiceComponent> result = new ArrayList<ServiceComponent>();
ServiceComponent serviceComponent = null;
// create an appropriate instance of role configuration parser
@@ -1290,7 +1290,7 @@ public class ServiceContainerImpl
// get the default interceptors defined for the container
- ArrayList defaultInterceptorList =
this.getDefaultInterceptorServiceList();
+ ArrayList<String> defaultInterceptorList =
this.getDefaultInterceptorServiceList();
// create the service components based on the role entries
@@ -1386,7 +1386,7 @@ public class ServiceContainerImpl
try
{
- Class resolverClass = this.getClassLoader().loadClass( className );
+ Class<?> resolverClass = this.getClassLoader().loadClass(
className );
resolver = (ComponentConfigurationPropertiesResolver)
resolverClass.newInstance();
ContainerUtil.enableLogging(resolver, this.getLogger());
ContainerUtil.contextualize(resolver, this.getContext());
@@ -1626,7 +1626,7 @@ public class ServiceContainerImpl
/**
* @return Returns the defaultInterceptorServiceList.
*/
- private ArrayList getDefaultInterceptorServiceList()
+ private ArrayList<String> getDefaultInterceptorServiceList()
{
return defaultInterceptorServiceList;
}
Modified:
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/context/AvalonToYaafiContextMapper.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/context/AvalonToYaafiContextMapper.java?rev=1847680&r1=1847679&r2=1847680&view=diff
==============================================================================
---
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/context/AvalonToYaafiContextMapper.java
(original)
+++
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/context/AvalonToYaafiContextMapper.java
Wed Nov 28 22:01:47 2018
@@ -53,6 +53,7 @@ public class AvalonToYaafiContextMapper
*
* @param tempRootDir current temp directory
* @param context the existing context
+ * @param classLoader the classloader
*/
public AvalonToYaafiContextMapper(
File tempRootDir,
Modified:
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/util/InputStreamLocator.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/util/InputStreamLocator.java?rev=1847680&r1=1847679&r2=1847680&view=diff
==============================================================================
---
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/util/InputStreamLocator.java
(original)
+++
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/framework/util/InputStreamLocator.java
Wed Nov 28 22:01:47 2018
@@ -75,8 +75,8 @@ public class InputStreamLocator
* Locate the file with the given position using the following steps
*
* @param location the location of the source to be loaded
- * @return
- * @throws IOException
+ * @return input stream of the source
+ * @throws IOException if source is not found
*/
public InputStream locate( String location ) throws IOException
{
Modified:
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/service/shutdown/ShutdownEntry.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/service/shutdown/ShutdownEntry.java?rev=1847680&r1=1847679&r2=1847680&view=diff
==============================================================================
---
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/service/shutdown/ShutdownEntry.java
(original)
+++
turbine/fulcrum/trunk/yaafi/src/java/org/apache/fulcrum/yaafi/service/shutdown/ShutdownEntry.java
Wed Nov 28 22:01:47 2018
@@ -181,7 +181,7 @@ public class ShutdownEntry
/**
* Creates an InputStream
* @return InputStream of the location
- * @throws IOException
+ * @throws IOException if unable to open the stream
*/
public InputStream locate() throws IOException
{
@@ -258,12 +258,12 @@ public class ShutdownEntry
{
byte[] buf = new byte[BUF_SIZE];
int n = 0;
- int total = 0;
+ //int total = 0;
while ((n = is.read(buf)) > 0)
{
os.write(buf, 0, n);
- total += n;
+ //total += n;
}
is.close();
