MNG-2461: Write JavaDoc documentation

o added some Javadoc
o no code change

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@541188 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Vincent Siveton 2007-05-24 05:45:26 +00:00
parent 2cd10e1343
commit a66be7f905
2 changed files with 31 additions and 3 deletions

View File

@ -29,42 +29,63 @@ import java.util.List;
*/
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 )

View File

@ -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 @@ package org.apache.maven.settings.validation;
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 );
}