You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2007/05/24 07:45:27 UTC
svn commit: r541188 - in
/maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation:
SettingsValidationResult.java SettingsValidator.java
Author: vsiveton
Date: Wed May 23 22:45:26 2007
New Revision: 541188
URL: http://svn.apache.org/viewvc?view=rev&rev=541188
Log:
MNG-2461: Write JavaDoc documentation
o added some Javadoc
o no code change
Modified:
maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation/SettingsValidationResult.java
maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation/SettingsValidator.java
Modified: maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation/SettingsValidationResult.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation/SettingsValidationResult.java?view=diff&rev=541188&r1=541187&r2=541188
==============================================================================
--- maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation/SettingsValidationResult.java (original)
+++ maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation/SettingsValidationResult.java Wed May 23 22:45:26 2007
@@ -29,42 +29,63 @@
*/
public final class SettingsValidationResult
{
- /** */
private final static String NEWLINE = System.getProperty( "line.separator" );
- /** */
private List messages;
+ /**
+ * Default constructor
+ */
public SettingsValidationResult()
{
messages = new ArrayList();
}
+ /**
+ * @return
+ */
public int getMessageCount()
{
return messages.size();
}
+ /**
+ * @param i
+ * @return
+ */
public String getMessage( int i )
{
return messages.get( i ).toString();
}
+ /**
+ * @return
+ */
public List getMessages()
{
return Collections.unmodifiableList( messages );
}
+ /**
+ * @param message
+ */
public void addMessage( String message )
{
messages.add( message );
}
+ /**
+ * @see java.lang.Object#toString()
+ */
public String toString()
{
return render( "" );
}
+ /**
+ * @param indentation
+ * @return
+ */
public String render( String indentation )
{
if ( messages.size() == 0 )
Modified: maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation/SettingsValidator.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation/SettingsValidator.java?view=diff&rev=541188&r1=541187&r2=541188
==============================================================================
--- maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation/SettingsValidator.java (original)
+++ maven/components/trunk/maven-settings/src/main/java/org/apache/maven/settings/validation/SettingsValidator.java Wed May 23 22:45:26 2007
@@ -1,6 +1,5 @@
package org.apache.maven.settings.validation;
-
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@@ -23,11 +22,19 @@
import org.apache.maven.settings.Settings;
/**
+ * Validate a model settings
+ *
* @author Milos Kleint
*/
public interface SettingsValidator
{
String ROLE = SettingsValidator.class.getName();
+ /**
+ * Validate a model settings
+ *
+ * @param model
+ * @return a <code>SettingsValidationResult</code> instance
+ */
SettingsValidationResult validate( Settings model );
}