inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-07 17:49:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor JavaDoc trimming

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18867 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
2010-02-25 23:35:22 +00:00
parent 7524b7009b
commit f8c7f7432d
2 changed files with 41 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
source/java/org/alfresco/repo/audit/model/AuditModelRegistryImpl.java
View File

@@ -83,10 +83,8 @@ import org.xml.sax.SAXParseException;
*/ */
public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implements AuditModelRegistry public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implements AuditModelRegistry
{ {
/** The name of the global enablement property. */ /** The name of the global enablement property. */
private static final String PROPERTY_AUDIT_ENABLED = "audit.enabled"; private static final String PROPERTY_AUDIT_ENABLED = "audit.enabled";
private static final String AUDIT_SCHEMA_LOCATION = "classpath:alfresco/audit/alfresco-audit-3.2.xsd"; private static final String AUDIT_SCHEMA_LOCATION = "classpath:alfresco/audit/alfresco-audit-3.2.xsd";
private static final Log logger = LogFactory.getLog(AuditModelRegistryImpl.class); private static final Log logger = LogFactory.getLog(AuditModelRegistryImpl.class);
@@ -99,7 +97,7 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
private final ObjectFactory objectFactory; private final ObjectFactory objectFactory;
/** /**
* @see org.alfresco.repo.management.subsystems.AbstractPropertyBackedBean#afterPropertiesSet() * {@inheritDoc}
*/ */
@Override @Override
public void afterPropertiesSet() throws Exception public void afterPropertiesSet() throws Exception
@@ -113,7 +111,7 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
} }
/** /**
* @see org.alfresco.repo.management.subsystems.AbstractPropertyBackedBean#getState(boolean) * {@inheritDoc}
*/ */
@Override @Override
protected synchronized AuditModelRegistryState getState(boolean start) protected synchronized AuditModelRegistryState getState(boolean start)
@@ -122,7 +120,7 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
} }
/** /**
* @see org.alfresco.repo.audit.model.AuditModelRegistry#getAuditApplicationByKey(java.lang.String) * {@inheritDoc}
*/ */
public AuditApplication getAuditApplicationByKey(String key) public AuditApplication getAuditApplicationByKey(String key)
{ {
@@ -130,7 +128,7 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
} }
/** /**
* @see org.alfresco.repo.audit.model.AuditModelRegistry#getAuditApplicationByName(java.lang.String) * {@inheritDoc}
*/ */
public AuditApplication getAuditApplicationByName(String applicationName) public AuditApplication getAuditApplicationByName(String applicationName)
{ {
@@ -138,7 +136,7 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
} }
/** /**
* @see org.alfresco.repo.audit.model.AuditModelRegistry#getAuditPathMapper() * {@inheritDoc}
*/ */
public PathMapper getAuditPathMapper() public PathMapper getAuditPathMapper()
{ {
@@ -146,7 +144,7 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
} }
/** /**
* @see org.alfresco.repo.audit.model.AuditModelRegistry#loadAuditModels() * {@inheritDoc}
*/ */
public void loadAuditModels() public void loadAuditModels()
{ {
@@ -173,7 +171,6 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
*/ */
public class AuditModelRegistryState implements PropertyBackedBeanState public class AuditModelRegistryState implements PropertyBackedBeanState
{ {
/** The audit models. */ /** The audit models. */
private final Map<URL, Audit> auditModels; private final Map<URL, Audit> auditModels;
@@ -346,8 +343,10 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
{ {
public Void doWork() throws Exception public Void doWork() throws Exception
{ {
transactionService.getRetryingTransactionHelper().doInTransaction(loadModelsCallback, transactionService.getRetryingTransactionHelper().doInTransaction(
transactionService.isReadOnly(), true); loadModelsCallback,
transactionService.isReadOnly(),
true);
return null; return null;
} }
}, AuthenticationUtil.getSystemUserName()); }, AuthenticationUtil.getSystemUserName());
@@ -356,8 +355,8 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
auditPathMapper.lock(); auditPathMapper.lock();
} }
/* (non-Javadoc) /**
* @see org.alfresco.repo.management.subsystems.PropertyBackedBeanState#stop() * {@inheritDoc}
*/ */
public void stop() public void stop()
{ {
@@ -605,7 +604,7 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
} }
/** /**
* @see org.alfresco.repo.management.subsystems.AbstractPropertyBackedBean#createInitialState() * {@inheritDoc}
*/ */
@Override @Override
protected PropertyBackedBeanState createInitialState() throws IOException protected PropertyBackedBeanState createInitialState() throws IOException
@@ -624,9 +623,6 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
/** /**
* Sets the search path for config files. * Sets the search path for config files.
*
* @param searchPath
* the search path
*/ */
public void setSearchPath(String[] searchPath) public void setSearchPath(String[] searchPath)
{ {
@@ -635,9 +631,6 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
/** /**
* Service to ensure DAO calls are transactionally wrapped. * Service to ensure DAO calls are transactionally wrapped.
*
* @param transactionService
* the transaction service
*/ */
public void setTransactionService(TransactionService transactionService) public void setTransactionService(TransactionService transactionService)
{ {
@@ -646,9 +639,6 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
/** /**
* Set the DAO used to persisted the registered audit models. * Set the DAO used to persisted the registered audit models.
*
* @param auditDAO
* the audit dao
*/ */
public void setAuditDAO(AuditDAO auditDAO) public void setAuditDAO(AuditDAO auditDAO)
{ {
@@ -657,9 +647,6 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
/** /**
* Set the registry of {@link DataExtractor data extractors}. * Set the registry of {@link DataExtractor data extractors}.
*
* @param dataExtractors
* the data extractors
*/ */
public void setDataExtractors(NamedObjectRegistry<DataExtractor> dataExtractors) public void setDataExtractors(NamedObjectRegistry<DataExtractor> dataExtractors)
{ {
@@ -668,9 +655,6 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
/** /**
* Set the registry of {@link DataGenerator data generators}. * Set the registry of {@link DataGenerator data generators}.
*
* @param dataGenerators
* the data generators
*/ */
public void setDataGenerators(NamedObjectRegistry<DataGenerator> dataGenerators) public void setDataGenerators(NamedObjectRegistry<DataGenerator> dataGenerators)
{ {
@@ -680,11 +664,9 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
/** /**
* Unmarshalls the Audit model from the URL. * Unmarshalls the Audit model from the URL.
* *
* @param configUrl * @param configUrl the config url
* the config url * @return the audit model
* @return the audit model * @throws AlfrescoRuntimeException if an IOException occurs
* @throws AlfrescoRuntimeException
* if an IOException occurs
*/ */
public static Audit unmarshallModel(URL configUrl) public static Audit unmarshallModel(URL configUrl)
{ {
@@ -702,12 +684,6 @@ public class AuditModelRegistryImpl extends AbstractPropertyBackedBean implement
/** /**
* Unmarshalls the Audit model from a stream. * Unmarshalls the Audit model from a stream.
*
* @param is
* the is
* @param source
* the source
* @return the audit model
*/ */
private static Audit unmarshallModel(InputStream is, final String source) private static Audit unmarshallModel(InputStream is, final String source)
{ {

64
source/java/org/alfresco/repo/management/subsystems/AbstractPropertyBackedBean.java
View File

@@ -53,7 +53,7 @@ import org.springframework.util.PropertyPlaceholderHelper;
* @author dward * @author dward
*/ */
public abstract class AbstractPropertyBackedBean implements PropertyBackedBean, ApplicationContextAware, public abstract class AbstractPropertyBackedBean implements PropertyBackedBean, ApplicationContextAware,
ApplicationListener, InitializingBean, DisposableBean, BeanNameAware ApplicationListener<ApplicationEvent>, InitializingBean, DisposableBean, BeanNameAware
{ {
/** The default final part of an ID. */ /** The default final part of an ID. */
@@ -215,9 +215,8 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean,
return this.state; return this.state;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
*/ */
public void afterPropertiesSet() throws Exception public void afterPropertiesSet() throws Exception
{ {
@@ -250,9 +249,8 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean,
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.alfresco.repo.management.subsystems.PropertyBackedBean#revert()
*/ */
public synchronized void revert() public synchronized void revert()
{ {
@@ -290,9 +288,8 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean,
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.alfresco.repo.management.subsystems.PropertyBackedBean#getId()
*/ */
public List<String> getId() public List<String> getId()
{ {
@@ -319,9 +316,8 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean,
return this.instancePath; return this.instancePath;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.springframework.beans.factory.DisposableBean#destroy()
*/ */
public void destroy() public void destroy()
{ {
@@ -346,28 +342,24 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean,
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.alfresco.repo.management.subsystems.PropertyBackedBean#isUpdateable(java.lang.String)
*/ */
public boolean isUpdateable(String name) public boolean isUpdateable(String name)
{ {
return true; return true;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.alfresco.repo.management.subsystems.PropertyBackedBean#getDescription(java.lang.String)
*/ */
public String getDescription(String name) public String getDescription(String name)
{ {
return isUpdateable(name) ? "Editable Property " + name : "Read-only Property " + name; return isUpdateable(name) ? "Editable Property " + name : "Read-only Property " + name;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see
* org.springframework.context.ApplicationListener#onApplicationEvent(org.springframework.context.ApplicationEvent)
*/ */
public void onApplicationEvent(ApplicationEvent event) public void onApplicationEvent(ApplicationEvent event)
{ {
@@ -395,9 +387,8 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean,
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.alfresco.repo.management.subsystems.PropertyBackedBeanState#getProperty(java.lang.String)
*/ */
public synchronized String getProperty(String name) public synchronized String getProperty(String name)
{ {
@@ -405,9 +396,8 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean,
return this.state.getProperty(name); return this.state.getProperty(name);
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.alfresco.repo.management.subsystems.PropertyBackedBeanState#getPropertyNames()
*/ */
public synchronized Set<String> getPropertyNames() public synchronized Set<String> getPropertyNames()
{ {
@@ -415,10 +405,8 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean,
return this.state.getPropertyNames(); return this.state.getPropertyNames();
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.alfresco.repo.management.subsystems.PropertyBackedBeanState#setProperty(java.lang.String,
* java.lang.String)
*/ */
public synchronized void setProperty(String name, String value) public synchronized void setProperty(String name, String value)
{ {
@@ -426,9 +414,8 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean,
this.state.setProperty(name, value); this.state.setProperty(name, value);
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.alfresco.repo.management.subsystems.PropertyBackedBeanState#start()
*/ */
public synchronized void start() public synchronized void start()
{ {
@@ -455,9 +442,8 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean,
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.alfresco.repo.management.subsystems.PropertyBackedBeanState#stop()
*/ */
public void stop() public void stop()
{ {