diff --git a/pom.xml b/pom.xml index cbc2d70..98d1389 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ org.jrimum jrimum-texgit Projeto Texgit - 0.2.3-DEV-SNAPSHOT + 0.2.6 Projeto open source de componentes de software para o domínio de negócios do Brasil. http://www.jrimum.org/texgit @@ -44,6 +44,10 @@ Rômulo Augusto romulomail@gmail.com + + Bruno Augusto + brunoaugustosilva8@gmail.com + @@ -58,18 +62,18 @@ maven-compiler-plugin 3.1 - 1.5 - 1.5 + 1.8 + 1.8 org.codehaus.mojo animal-sniffer-maven-plugin - 1.6 + 1.23 org.codehaus.mojo.signature - java15 + java18 1.0 @@ -162,7 +166,7 @@ org.jrimum jrimum-utilix - 0.2.3-DEV-SNAPSHOT + 0.2.5 sun-jaxb diff --git a/src/main/assembly/jrimum-texgit-with-dependencies.xml b/src/main/assembly/jrimum-texgit-with-dependencies.xml index 92a944e..2d308a9 100644 --- a/src/main/assembly/jrimum-texgit-with-dependencies.xml +++ b/src/main/assembly/jrimum-texgit-with-dependencies.xml @@ -14,7 +14,7 @@ true runtime - commons-lang:commons-lang + org.apache.commons:commons-lang3 log4j:log4j sun-jaxb:jaxb-api sun-jaxb:jaxb-impl diff --git a/src/main/java/org/jrimum/texgit/FlatFile.java b/src/main/java/org/jrimum/texgit/FlatFile.java index 4054a4d..f34ec5b 100644 --- a/src/main/java/org/jrimum/texgit/FlatFile.java +++ b/src/main/java/org/jrimum/texgit/FlatFile.java @@ -33,7 +33,7 @@ /** * @author Gilmar P.S.L. * - * @param + * @param Classe Genérica de Record */ public interface FlatFile extends TextListStream { diff --git a/src/main/java/org/jrimum/texgit/Texgit.java b/src/main/java/org/jrimum/texgit/Texgit.java index 514eee1..0ca31e3 100644 --- a/src/main/java/org/jrimum/texgit/Texgit.java +++ b/src/main/java/org/jrimum/texgit/Texgit.java @@ -28,7 +28,7 @@ */ package org.jrimum.texgit; -import static org.apache.commons.lang.StringUtils.isNotBlank; +import static org.apache.commons.lang3.StringUtils.isNotBlank; import static org.jrimum.utilix.Objects.isNotNull; import java.io.ByteArrayInputStream; diff --git a/src/main/java/org/jrimum/texgit/TexgitException.java b/src/main/java/org/jrimum/texgit/TexgitException.java index b518c31..fd75d8c 100644 --- a/src/main/java/org/jrimum/texgit/TexgitException.java +++ b/src/main/java/org/jrimum/texgit/TexgitException.java @@ -49,8 +49,8 @@ public TexgitException() { } /** - * @param arg0 - * @param arg1 + * @param arg0 Argumento 0 + * @param arg1 Stack Trace do erro */ public TexgitException(String arg0, Throwable arg1) { super(arg0, arg1); @@ -58,7 +58,7 @@ public TexgitException(String arg0, Throwable arg1) { } /** - * @param arg0 + * @param arg0 Argumento 0 */ public TexgitException(String arg0) { super(arg0); @@ -66,7 +66,7 @@ public TexgitException(String arg0) { } /** - * @param arg0 + * @param arg0 Stack trace do erro */ public TexgitException(Throwable arg0) { super(arg0); diff --git a/src/main/java/org/jrimum/texgit/engine/FixedFieldBuilder.java b/src/main/java/org/jrimum/texgit/engine/FixedFieldBuilder.java index 6e94526..dab0331 100644 --- a/src/main/java/org/jrimum/texgit/engine/FixedFieldBuilder.java +++ b/src/main/java/org/jrimum/texgit/engine/FixedFieldBuilder.java @@ -28,9 +28,9 @@ */ package org.jrimum.texgit.engine; -import static org.apache.commons.lang.StringUtils.EMPTY; -import static org.apache.commons.lang.StringUtils.countMatches; -import static org.apache.commons.lang.StringUtils.isNotBlank; +import static org.apache.commons.lang3.StringUtils.EMPTY; +import static org.apache.commons.lang3.StringUtils.countMatches; +import static org.apache.commons.lang3.StringUtils.isNotBlank; import static org.jrimum.utilix.Objects.isNotNull; import java.math.BigDecimal; diff --git a/src/main/java/org/jrimum/texgit/engine/RecordFactory.java b/src/main/java/org/jrimum/texgit/engine/RecordFactory.java index ea99f8f..394d765 100644 --- a/src/main/java/org/jrimum/texgit/engine/RecordFactory.java +++ b/src/main/java/org/jrimum/texgit/engine/RecordFactory.java @@ -28,7 +28,7 @@ */ package org.jrimum.texgit.engine; -import static org.apache.commons.lang.StringUtils.isNotBlank; +import static org.apache.commons.lang3.StringUtils.isNotBlank; import static org.jrimum.utilix.Objects.isNotNull; import java.util.HashMap; diff --git a/src/main/java/org/jrimum/texgit/engine/TexgitLanguageException.java b/src/main/java/org/jrimum/texgit/engine/TexgitLanguageException.java index 8c64d4b..e8e6b22 100644 --- a/src/main/java/org/jrimum/texgit/engine/TexgitLanguageException.java +++ b/src/main/java/org/jrimum/texgit/engine/TexgitLanguageException.java @@ -46,8 +46,8 @@ public TexgitLanguageException() { } /** - * @param arg0 - * @param arg1 + * @param arg0 Argumento 0 + * @param arg1 Argumento 1 */ public TexgitLanguageException(String arg0, Throwable arg1) { super(arg0, arg1); @@ -55,7 +55,7 @@ public TexgitLanguageException(String arg0, Throwable arg1) { } /** - * @param arg0 + * @param arg0 Argumento0 */ public TexgitLanguageException(String arg0) { super(arg0); @@ -63,7 +63,7 @@ public TexgitLanguageException(String arg0) { } /** - * @param arg0 + * @param arg0 Argumento - */ public TexgitLanguageException(Throwable arg0) { super(arg0); diff --git a/src/main/java/org/jrimum/texgit/language/EnumFormats.java b/src/main/java/org/jrimum/texgit/language/EnumFormats.java index c0ab828..72252f8 100644 --- a/src/main/java/org/jrimum/texgit/language/EnumFormats.java +++ b/src/main/java/org/jrimum/texgit/language/EnumFormats.java @@ -52,7 +52,7 @@ *

* The following schema fragment specifies the expected content contained within * this class. - *

+ *

* *
  * <simpleType name="enumFormats">
diff --git a/src/main/java/org/jrimum/texgit/language/EnumFormatsTypes.java b/src/main/java/org/jrimum/texgit/language/EnumFormatsTypes.java
index e9e48da..80aaa30 100644
--- a/src/main/java/org/jrimum/texgit/language/EnumFormatsTypes.java
+++ b/src/main/java/org/jrimum/texgit/language/EnumFormatsTypes.java
@@ -53,7 +53,7 @@
  * 

* The following schema fragment specifies the expected content contained within * this class. - *

+ *

* *
  * <simpleType name="enumFormatsTypes">
diff --git a/src/main/java/org/jrimum/texgit/language/EnumPaddings.java b/src/main/java/org/jrimum/texgit/language/EnumPaddings.java
index 33587c5..d1feacb 100644
--- a/src/main/java/org/jrimum/texgit/language/EnumPaddings.java
+++ b/src/main/java/org/jrimum/texgit/language/EnumPaddings.java
@@ -52,7 +52,7 @@
  * 

* The following schema fragment specifies the expected content contained within * this class. - *

+ *

* *
  * <simpleType name="enumPaddings">
diff --git a/src/main/java/org/jrimum/texgit/language/EnumSide.java b/src/main/java/org/jrimum/texgit/language/EnumSide.java
index 32ba029..a83b632 100644
--- a/src/main/java/org/jrimum/texgit/language/EnumSide.java
+++ b/src/main/java/org/jrimum/texgit/language/EnumSide.java
@@ -52,7 +52,7 @@
  * 

* The following schema fragment specifies the expected content contained within * this class. - *

+ *

* *
  * <simpleType name="enumSide">
diff --git a/src/main/java/org/jrimum/texgit/language/EnumTypes.java b/src/main/java/org/jrimum/texgit/language/EnumTypes.java
index ddd4cad..52f2294 100644
--- a/src/main/java/org/jrimum/texgit/language/EnumTypes.java
+++ b/src/main/java/org/jrimum/texgit/language/EnumTypes.java
@@ -41,8 +41,8 @@
  * 
  * 
  * 

- * Tipos usados para obten��o dos campos de texto para java. No caso representa - * os tipos java poss�veis para um campo. + * Tipos usados para obtenção dos campos de texto para java. No caso representa + * os tipos java possíveis para um campo. *

* * @@ -53,7 +53,7 @@ *

* The following schema fragment specifies the expected content contained within * this class. - *

+ *

* *
  * <simpleType name="enumTypes">
diff --git a/src/main/java/org/jrimum/texgit/language/MetaField.java b/src/main/java/org/jrimum/texgit/language/MetaField.java
index 2ac6d74..dc17220 100644
--- a/src/main/java/org/jrimum/texgit/language/MetaField.java
+++ b/src/main/java/org/jrimum/texgit/language/MetaField.java
@@ -197,6 +197,7 @@ public void setFormat(EnumFormats value) {
 	/**
 	 * Gets the value of the length property.
 	 * 
+	 * @return Tamanho do campo
 	 */
 	public int getLength() {
 		return length;
@@ -205,6 +206,7 @@ public int getLength() {
 	/**
 	 * Sets the value of the length property.
 	 * 
+	 * @param value Tamanho do campo
 	 */
 	public void setLength(int value) {
 		this.length = value;
diff --git a/src/main/java/org/jrimum/texgit/language/MetaGroupFields.java b/src/main/java/org/jrimum/texgit/language/MetaGroupFields.java
index e43ae9f..9cead99 100644
--- a/src/main/java/org/jrimum/texgit/language/MetaGroupFields.java
+++ b/src/main/java/org/jrimum/texgit/language/MetaGroupFields.java
@@ -107,7 +107,7 @@ public void setIdType(MetaOrderedField value) {
 	 * Objects of the following type(s) are allowed in the list
 	 * {@link MetaField }
 	 * 
-	 * 
+	 * @return Lista de campos
 	 */
 	public List getFields() {
 		if (fields == null) {
diff --git a/src/main/java/org/jrimum/texgit/language/MetaGroupRecords.java b/src/main/java/org/jrimum/texgit/language/MetaGroupRecords.java
index d55309b..af5a8b4 100644
--- a/src/main/java/org/jrimum/texgit/language/MetaGroupRecords.java
+++ b/src/main/java/org/jrimum/texgit/language/MetaGroupRecords.java
@@ -83,7 +83,7 @@ public class MetaGroupRecords {
 	 * Objects of the following type(s) are allowed in the list
 	 * {@link MetaRecord }
 	 * 
-	 * 
+	 * @return Lista de instruções
 	 */
 	public List getRecords() {
 		if (records == null) {
diff --git a/src/main/java/org/jrimum/texgit/language/MetaOrderedField.java b/src/main/java/org/jrimum/texgit/language/MetaOrderedField.java
index 3638719..4b1c592 100644
--- a/src/main/java/org/jrimum/texgit/language/MetaOrderedField.java
+++ b/src/main/java/org/jrimum/texgit/language/MetaOrderedField.java
@@ -62,6 +62,7 @@ public class MetaOrderedField extends MetaField {
 	/**
 	 * Gets the value of the position property.
 	 * 
+	 * @return Posição
 	 */
 	public int getPosition() {
 		return position;
@@ -70,6 +71,7 @@ public int getPosition() {
 	/**
 	 * Sets the value of the position property.
 	 * 
+	 * @param value Posição do campo
 	 */
 	public void setPosition(int value) {
 		this.position = value;
diff --git a/src/main/java/org/jrimum/texgit/language/ObjectFactory.java b/src/main/java/org/jrimum/texgit/language/ObjectFactory.java
index b7a513b..2db7ce4 100644
--- a/src/main/java/org/jrimum/texgit/language/ObjectFactory.java
+++ b/src/main/java/org/jrimum/texgit/language/ObjectFactory.java
@@ -68,6 +68,7 @@ public ObjectFactory() {
 	/**
 	 * Create an instance of {@link MetaField }
 	 * 
+	 * @return Objeto do campo
 	 */
 	public MetaField createMetaField() {
 		return new MetaField();
@@ -76,6 +77,7 @@ public MetaField createMetaField() {
 	/**
 	 * Create an instance of {@link MetaFlatFile }
 	 * 
+	 * @return Objeto de MetaFlatFile
 	 */
 	public MetaFlatFile createMetaFlatFile() {
 		return new MetaFlatFile();
@@ -84,6 +86,7 @@ public MetaFlatFile createMetaFlatFile() {
 	/**
 	 * Create an instance of {@link MetaOrderedField }
 	 * 
+	 * @return objeto MetaOrderedField
 	 */
 	public MetaOrderedField createMetaOrderedField() {
 		return new MetaOrderedField();
@@ -92,6 +95,7 @@ public MetaOrderedField createMetaOrderedField() {
 	/**
 	 * Create an instance of {@link MetaRecord }
 	 * 
+	 * @return Objeto de MetaRecord
 	 */
 	public MetaRecord createMetaRecord() {
 		return new MetaRecord();
@@ -100,6 +104,7 @@ public MetaRecord createMetaRecord() {
 	/**
 	 * Create an instance of {@link MetaLayout }
 	 * 
+	 * @return Objeto de MetaLayout
 	 */
 	public MetaLayout createMetaLayout() {
 		return new MetaLayout();
@@ -108,6 +113,7 @@ public MetaLayout createMetaLayout() {
 	/**
 	 * Create an instance of {@link MetaTexgit }
 	 * 
+	 * @return Objeto de MetaTexgits
 	 */
 	public MetaTexgit createMetaTexgit() {
 		return new MetaTexgit();
@@ -116,6 +122,7 @@ public MetaTexgit createMetaTexgit() {
 	/**
 	 * Create an instance of {@link MetaFormatter }
 	 * 
+	 * @return Objeto de MetaFormatter
 	 */
 	public MetaFormatter createMetaFormatter() {
 		return new MetaFormatter();
@@ -124,6 +131,7 @@ public MetaFormatter createMetaFormatter() {
 	/**
 	 * Create an instance of {@link MetaGroupFields }
 	 * 
+	 * @return Objeto de MetaGroupFields
 	 */
 	public MetaGroupFields createMetaGroupFields() {
 		return new MetaGroupFields();
@@ -132,6 +140,7 @@ public MetaGroupFields createMetaGroupFields() {
 	/**
 	 * Create an instance of {@link MetaGroupRecords }
 	 * 
+	 * @return Objeto de MetaGroupRecords
 	 */
 	public MetaGroupRecords createMetaGroupRecords() {
 		return new MetaGroupRecords();
@@ -140,6 +149,7 @@ public MetaGroupRecords createMetaGroupRecords() {
 	/**
 	 * Create an instance of {@link MetaFiller }
 	 * 
+	 * @return Objeto de MetaFiller
 	 */
 	public MetaFiller createMetaFiller() {
 		return new MetaFiller();
@@ -148,6 +158,8 @@ public MetaFiller createMetaFiller() {
 	/**
 	 * Create an instance of {@link JAXBElement }{@code <}{@link MetaTexgit }{@code >}}
 	 * 
+	 * @param value Objeto do MetaTexgit
+	 * @return JAXBElement
 	 */
 	@XmlElementDecl(namespace = "http://jrimum.org/texgit", name = "Texgit")
 	public JAXBElement createTexgit(MetaTexgit value) {
@@ -157,6 +169,8 @@ public JAXBElement createTexgit(MetaTexgit value) {
 
 	/**
 	 * Create an instance of {@link MetaGroupFields.SequencialNumber }}
+	 * @param value Objeto do MetaOrderedField
+	 * @return MetaGroupFields.SequencialNumber	
 	 * 
 	 */
 	@XmlElementDecl(namespace = "", name = "SequencialNumber", scope = MetaGroupFields.class)
@@ -167,6 +181,8 @@ public MetaGroupFields.SequencialNumber createMetaGroupFieldsSequencialNumber(
 
 	/**
 	 * Create an instance of {@link MetaGroupFields.IdType }}
+	 * @param value Objeto do MetaOrderedField
+	 * @return MetaGroupFields.IdType	
 	 * 
 	 */
 	@XmlElementDecl(namespace = "", name = "IdType", scope = MetaGroupFields.class)
diff --git a/src/main/java/org/jrimum/texgit/type/AbstractStringOfFields.java b/src/main/java/org/jrimum/texgit/type/AbstractStringOfFields.java
index c25e88d..af6557f 100644
--- a/src/main/java/org/jrimum/texgit/type/AbstractStringOfFields.java
+++ b/src/main/java/org/jrimum/texgit/type/AbstractStringOfFields.java
@@ -36,7 +36,7 @@
 import java.util.List;
 import java.util.ListIterator;
 
-import org.apache.commons.lang.StringUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.jrimum.texgit.TextStream;
 import org.jrimum.utilix.Collections;
 import org.jrimum.utilix.Objects;
@@ -44,7 +44,7 @@
 /**
  * @author Gilmar P.S.L.
  *
- * @param 
+ * @param  Tipo do field contido na StringOfFields
  */
 @SuppressWarnings("serial")
 public abstract class AbstractStringOfFields> implements TextStream, List, Cloneable{
@@ -63,6 +63,7 @@ public AbstractStringOfFields() {
 	}
 	
 	/**
+	 * @param size Quantidade de fields que a StringOfFields deve conter. Deve ser um número natural > 0.
 	 * 
 	 */
 	public AbstractStringOfFields(Integer size) {
diff --git a/src/main/java/org/jrimum/texgit/type/Field.java b/src/main/java/org/jrimum/texgit/type/Field.java
index d9a3902..58ae75f 100644
--- a/src/main/java/org/jrimum/texgit/type/Field.java
+++ b/src/main/java/org/jrimum/texgit/type/Field.java
@@ -35,7 +35,7 @@
 /**
  * @author Gilmar P.S.L.
  *
- * @param 
+ * @param  Tipo do field contido na StringOfFields
  */
 public interface Field extends TextStream, Cloneable{
 
diff --git a/src/main/java/org/jrimum/texgit/type/Filler.java b/src/main/java/org/jrimum/texgit/type/Filler.java
index 7ee56e6..fac4d4a 100644
--- a/src/main/java/org/jrimum/texgit/type/Filler.java
+++ b/src/main/java/org/jrimum/texgit/type/Filler.java
@@ -11,13 +11,13 @@ public interface Filler extends Serializable{
 	 * 
 	 * 

* Exemplo: - *
+ *
* Se sideToFill == SideToFill.LEFT, o caracter especificado será adicionado à String * no lado esquerdo até que o campo fique com o tamanho que foi definido. *

* - * @param toFill - * @param length + * @param toFill String a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * * @since 0.2 @@ -28,8 +28,8 @@ public interface Filler extends Serializable{ * Executa o método fill(String, int) passando o parâmetro * toFill como String.valueOf(toFill). * - * @param tofill - * @param length + * @param tofill String a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * * @see Filler#fill(String, int) @@ -42,8 +42,8 @@ public interface Filler extends Serializable{ * Executa o método fill(String, int) passando o parâmetro * toFill como String.valueOf(toFill). * - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * * @see Filler#fill(String, int) @@ -56,8 +56,8 @@ public interface Filler extends Serializable{ * Executa o método fill(String, int) passando o parâmetro * toFill como String.valueOf(toFill). * - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * * @see Filler#fill(String, int) @@ -70,8 +70,8 @@ public interface Filler extends Serializable{ * Executa o método fill(String, int) passando o parâmetro * toFill como String.valueOf(toFill). * - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * * @see Filler#fill(String, int) @@ -84,8 +84,8 @@ public interface Filler extends Serializable{ * Executa o método fill(String, int) passando o parâmetro * toFill como String.valueOf(toFill). * - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * * @see Filler#fill(String, int) @@ -98,8 +98,8 @@ public interface Filler extends Serializable{ * Executa o método fill(String, int) passando o parâmetro * toFill como String.valueOf(toFill). * - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * * @see Filler#fill(String, int) @@ -112,13 +112,13 @@ public interface Filler extends Serializable{ * Executa o método fill(String, int) passando o parâmetro * toFill como String.valueOf(toFill). * - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * * @see Filler#fill(String, int) * - * @since + * @since 0.2 */ String fill(float tofill, int length); @@ -131,8 +131,8 @@ public interface Filler extends Serializable{ * fill(String, int) receberá uma String nula como parâmetro. *

* - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * * @see Filler#fill(String, int) @@ -150,8 +150,8 @@ public interface Filler extends Serializable{ * fill(String, int) receberá uma String nula como parâmetro. *

* - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * * @see Filler#fill(String, int) diff --git a/src/main/java/org/jrimum/texgit/type/Fixed.java b/src/main/java/org/jrimum/texgit/type/Fixed.java index 9fbd384..f04a0f5 100644 --- a/src/main/java/org/jrimum/texgit/type/Fixed.java +++ b/src/main/java/org/jrimum/texgit/type/Fixed.java @@ -35,7 +35,7 @@ public interface Fixed { /** - * Informa a validade para a fixação de uma ou mais medidas. Exemplo:
+ * Informa a validade para a fixação de uma ou mais medidas. Exemplo:
* *
 	 * {
@@ -46,7 +46,7 @@ public interface Fixed {
 	 * 
 	 * @return Indicativo se está de acordo com o definido
 	 * 
-	 * @throws IllegalStateException
+	 * @throws IllegalStateException se a medida não estiver de acordo com o definidos
 	 */
 	public abstract boolean isFixedAsDefined() throws IllegalStateException;
 }
diff --git a/src/main/java/org/jrimum/texgit/type/FixedField.java b/src/main/java/org/jrimum/texgit/type/FixedField.java
index e1073cc..7425f04 100644
--- a/src/main/java/org/jrimum/texgit/type/FixedField.java
+++ b/src/main/java/org/jrimum/texgit/type/FixedField.java
@@ -32,7 +32,7 @@
 /**
  * @author Gilmar P.S.L.
  *
- * @param 
+ * @param  Tipo do field contido na StringOfFields
  */
 public interface FixedField extends Field, FixedLength{
 
diff --git a/src/main/java/org/jrimum/texgit/type/component/BlockOfFields.java b/src/main/java/org/jrimum/texgit/type/component/BlockOfFields.java
index b54572e..959dcf3 100644
--- a/src/main/java/org/jrimum/texgit/type/component/BlockOfFields.java
+++ b/src/main/java/org/jrimum/texgit/type/component/BlockOfFields.java
@@ -76,8 +76,8 @@ public BlockOfFields() {
 	}
 
 	/**
-	 * @param length
-	 * @param size
+	 * @param length Tamanho do bloco
+	 * @param size Número de fields do bloco
 	 */
 	public BlockOfFields(Integer length, Integer size) {
 
diff --git a/src/main/java/org/jrimum/texgit/type/component/Field.java b/src/main/java/org/jrimum/texgit/type/component/Field.java
index bae9ab5..d6cf347 100644
--- a/src/main/java/org/jrimum/texgit/type/component/Field.java
+++ b/src/main/java/org/jrimum/texgit/type/component/Field.java
@@ -29,9 +29,9 @@
 package org.jrimum.texgit.type.component;
 
 import static java.lang.String.format;
-import static org.apache.commons.lang.StringUtils.EMPTY;
-import static org.apache.commons.lang.StringUtils.isBlank;
-import static org.apache.commons.lang.StringUtils.isNumeric;
+import static org.apache.commons.lang3.StringUtils.EMPTY;
+import static org.apache.commons.lang3.StringUtils.isBlank;
+import static org.apache.commons.lang3.StringUtils.isNumeric;
 import static org.jrimum.utilix.Objects.isNotNull;
 
 import java.lang.reflect.Constructor;
@@ -48,7 +48,7 @@
 /**
  * @author Gilmar P.S.L.
  *
- * @param 
+ * @param  Tipo do field contido na StringOfFields
  */
 @SuppressWarnings("serial")
 public class Field implements org.jrimum.texgit.type.Field{
@@ -89,7 +89,7 @@ public Field() {
 	}
 
 	/**
-	 * @param value
+	 * @param value Valor do campo
 	 */
 	public Field(G value) {
 		super();
@@ -102,8 +102,8 @@ public Field(G value) {
 	 * será de acordo com o formatador.
 	 * 

* - * @param value - * @param formatter + * @param value Valor do campo + * @param formatter Formatador utilizado na leitura e escrita do valor do campo */ public Field(G value, Format formatter){ @@ -112,8 +112,8 @@ public Field(G value, Format formatter){ } /** - * @param name - * @param value + * @param name Nome do campo + * @param value Valor do campo */ public Field(String name, G value) { super(); @@ -127,9 +127,9 @@ public Field(String name, G value) { * Cria um Field com nome para identificação, valor e um formatador. *

* - * @param name - * @param value - * @param formatter + * @param name Nome do campo + * @param value Valor do campo + * @param formatter Formatador utilizado na leitura e escrita do valor do campo * * @see #Field(Object, Format) */ diff --git a/src/main/java/org/jrimum/texgit/type/component/Filler.java b/src/main/java/org/jrimum/texgit/type/component/Filler.java index 2ffeb96..7d56506 100644 --- a/src/main/java/org/jrimum/texgit/type/component/Filler.java +++ b/src/main/java/org/jrimum/texgit/type/component/Filler.java @@ -29,10 +29,10 @@ package org.jrimum.texgit.type.component; import static java.lang.String.format; -import static org.apache.commons.lang.StringUtils.EMPTY; +import static org.apache.commons.lang3.StringUtils.EMPTY; import static org.jrimum.utilix.Objects.isNotNull; -import org.apache.commons.lang.StringUtils; +import org.apache.commons.lang3.StringUtils; import org.jrimum.texgit.TextStream; import org.jrimum.utilix.Objects; @@ -47,14 +47,15 @@ * É utilizado o método toString() do objeto preenchedor. *

*

- * Exemplo:
+ * Exemplo:
+ *

*
- * Filler filler = new Filler(new Integer(10), SideToFill.LEFT);
+ * Filler<Integer> filler = new Filler(new Integer(10), SideToFill.LEFT);
  * String outPut = filler.fill("TESTE", 8);
  * 
- * outPut -> "101TESTE"
+ * outPut -> "101TESTE"
  * 
- *

+ * * @author Gilmar P.S.L * @author Misael Barreto * @author Rômulo Augusto @@ -78,7 +79,8 @@ public Filler() { } /** - * @param fillWith + * @param fillWith Objeto a ser utilizado como preenchimento + * O lado de preenchimento será o lado esquerdo. */ public Filler(G fillWith) { @@ -87,8 +89,8 @@ public Filler(G fillWith) { } /** - * @param fillWith - * @param sideToFill + * @param fillWith Objeto a ser utilizado como preenchimento + * @param sideToFill Lado de preenchimento */ public Filler(G fillWith, Side sideToFill) { @@ -97,14 +99,17 @@ public Filler(G fillWith, Side sideToFill) { } /** - * @see org.jrimum.texgit.type#getPadding() + * @see org.jrimum.texgit.type.Filler + * @return Objeto a ser utilizado como preenchimento */ public G getPadding() { return padding; } /** - * @see org.jrimum.texgit.type#setPadding(G) + * @see org.jrimum.texgit.type.Filler + * @param fillWith Objeto a ser utilizado como preenchimento + * @throws IllegalArgumentException se o objeto de preenchimento for nulo */ public void setPadding(G fillWith) { @@ -116,14 +121,17 @@ public void setPadding(G fillWith) { } /** - * @see org.jrimum.texgit.type#getSideToFill() + * @see org.jrimum.texgit.type.Filler + * @return Lado de preenchimento */ public Side getSideToFill() { return sideToFill; } /** - * @see org.jrimum.texgit.type#setSideToFill(org.jrimum.texgit.type.component.Side) + * @see org.jrimum.texgit.type.Filler + * @param sideToFill Lado de preenchimento + * @throws IllegalArgumentException se o lado de preenchimento for nulo */ public void setSideToFill(Side sideToFill) { @@ -135,7 +143,7 @@ public void setSideToFill(Side sideToFill) { } /** - * @see org.jrimum.texgit.type#fill(java.lang.String, int) + * @see org.jrimum.texgit.type.Filler */ public String fill(String toFill, int length){ @@ -156,56 +164,56 @@ public String fill(String toFill, int length){ } /** - * @see org.jrimum.texgit.type#fill(long, int) + * @see org.jrimum.texgit.type.Filler */ public String fill(long tofill, int length){ return fill(String.valueOf(tofill), length); } /** - * @see org.jrimum.texgit.type#fill(int, int) + * @see org.jrimum.texgit.type.Filler */ public String fill(int tofill, int length){ return fill(String.valueOf(tofill), length); } /** - * @see org.jrimum.texgit.type#fill(short, int) + * @see org.jrimum.texgit.type.Filler */ public String fill(short tofill, int length){ return fill(String.valueOf(tofill), length); } /** - * @see org.jrimum.texgit.type#fill(byte, int) + * @see org.jrimum.texgit.type.Filler */ public String fill(byte tofill, int length){ return fill(String.valueOf(tofill), length); } /** - * @see org.jrimum.texgit.type#fill(char, int) + * @see org.jrimum.texgit.type.Filler */ public String fill(char tofill, int length){ return fill(String.valueOf(tofill), length); } /** - * @see org.jrimum.texgit.type#fill(double, int) + * @see org.jrimum.texgit.type.Filler */ public String fill(double tofill, int length){ return fill(String.valueOf(tofill), length); } /** - * @see org.jrimum.texgit.type#fill(float, int) + * @see org.jrimum.texgit.type.Filler */ public String fill(float tofill, int length){ return fill(String.valueOf(tofill), length); } /** - * @see org.jrimum.texgit.type#fill(java.lang.Object, int) + * @see org.jrimum.texgit.type.Filler */ public String fill(Object tofill, int length){ @@ -219,7 +227,7 @@ public String fill(Object tofill, int length){ } /** - * @see org.jrimum.texgit.type#fill(org.jrimum.texgit.TextStream, int) + * @see org.jrimum.texgit.type.Filler */ public String fill(TextStream tofill, int length){ @@ -233,8 +241,8 @@ public String fill(TextStream tofill, int length){ } /** - * @param toFill - * @param length + * @param toFill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida */ private String fillRight(String toFill, int length) { @@ -243,8 +251,8 @@ private String fillRight(String toFill, int length) { } /** - * @param toFill - * @param length + * @param toFill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida */ private String fillLeft(String toFill, int length) { diff --git a/src/main/java/org/jrimum/texgit/type/component/Fillers.java b/src/main/java/org/jrimum/texgit/type/component/Fillers.java index b6aa9ed..682d0fe 100644 --- a/src/main/java/org/jrimum/texgit/type/component/Fillers.java +++ b/src/main/java/org/jrimum/texgit/type/component/Fillers.java @@ -65,8 +65,8 @@ private Fillers(Filler filler){ } /** - * @param toFill - * @param length + * @param toFill String a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * @see org.jrimum.texgit.type.component.Filler#fill(java.lang.String, int) */ @@ -75,8 +75,8 @@ public String fill(String toFill, int length) { } /** - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * @see org.jrimum.texgit.type.component.Filler#fill(long, int) */ @@ -85,8 +85,8 @@ public String fill(long tofill, int length) { } /** - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * @see org.jrimum.texgit.type.component.Filler#fill(int, int) */ @@ -95,8 +95,8 @@ public String fill(int tofill, int length) { } /** - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * @see org.jrimum.texgit.type.component.Filler#fill(short, int) */ @@ -105,8 +105,8 @@ public String fill(short tofill, int length) { } /** - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * @see org.jrimum.texgit.type.component.Filler#fill(byte, int) */ @@ -115,8 +115,8 @@ public String fill(byte tofill, int length) { } /** - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * @see org.jrimum.texgit.type.component.Filler#fill(char, int) */ @@ -125,8 +125,8 @@ public String fill(char tofill, int length) { } /** - * @param tofill - * @param length + * @param tofill string a ser preenchida + * @param length Tamanho desejado da string preenchida * @return String preenchida * @see org.jrimum.texgit.type.component.Filler#fill(double, int) */ @@ -135,8 +135,8 @@ public String fill(double tofill, int length) { } /** - * @param tofill - * @param length + * @param tofill Percentual a ser preenchido + * @param length Tamanho a ser preenchido * @return String preenchida * @see org.jrimum.texgit.type.component.Filler#fill(float, int) */ @@ -145,8 +145,8 @@ public String fill(float tofill, int length) { } /** - * @param tofill - * @param length + * @param tofill Objeto a ser preenchido + * @param length Tamanho desejado da string preenchida * @return String preenchida * @see org.jrimum.texgit.type.component.Filler#fill(java.lang.Object, int) */ @@ -155,8 +155,8 @@ public String fill(Object tofill, int length) { } /** - * @param tofill - * @param length + * @param tofill TextStream a ser preenchido + * @param length Tamanho desejado da string preenchida * @return String preenchida * @see org.jrimum.texgit.type.component.Filler#fill(org.jrimum.texgit.TextStream, int) */ diff --git a/src/main/java/org/jrimum/texgit/type/component/FixedField.java b/src/main/java/org/jrimum/texgit/type/component/FixedField.java index 9adcd7f..40dcb1f 100644 --- a/src/main/java/org/jrimum/texgit/type/component/FixedField.java +++ b/src/main/java/org/jrimum/texgit/type/component/FixedField.java @@ -29,7 +29,7 @@ package org.jrimum.texgit.type.component; import static java.lang.String.format; -import static org.apache.commons.lang.StringUtils.EMPTY; +import static org.apache.commons.lang3.StringUtils.EMPTY; import static org.jrimum.utilix.Objects.isNotNull; import java.text.Format; @@ -41,7 +41,7 @@ /** * @author Gilmar P.S.L. * - * @param + * @param Tipo do field contido na StringOfFields */ @SuppressWarnings("serial") public class FixedField extends Field implements org.jrimum.texgit.type.FixedField{ diff --git a/src/main/java/org/jrimum/texgit/type/component/FlatFile.java b/src/main/java/org/jrimum/texgit/type/component/FlatFile.java index 0a858f2..c06eaa7 100644 --- a/src/main/java/org/jrimum/texgit/type/component/FlatFile.java +++ b/src/main/java/org/jrimum/texgit/type/component/FlatFile.java @@ -29,8 +29,8 @@ package org.jrimum.texgit.type.component; import static java.lang.String.format; -import static org.apache.commons.lang.StringUtils.EMPTY; -import static org.apache.commons.lang.StringUtils.isNotBlank; +import static org.apache.commons.lang3.StringUtils.EMPTY; +import static org.apache.commons.lang3.StringUtils.isNotBlank; import static org.jrimum.utilix.Objects.isNotNull; import static org.jrimum.utilix.Objects.isNull; diff --git a/src/main/java/org/jrimum/texgit/type/component/Record.java b/src/main/java/org/jrimum/texgit/type/component/Record.java index 39de234..134b0c2 100644 --- a/src/main/java/org/jrimum/texgit/type/component/Record.java +++ b/src/main/java/org/jrimum/texgit/type/component/Record.java @@ -29,8 +29,8 @@ package org.jrimum.texgit.type.component; import static java.lang.String.format; -import static org.apache.commons.lang.StringUtils.EMPTY; -import static org.apache.commons.lang.StringUtils.isNotBlank; +import static org.apache.commons.lang3.StringUtils.EMPTY; +import static org.apache.commons.lang3.StringUtils.isNotBlank; import static org.jrimum.utilix.Objects.isNotNull; import static org.jrimum.utilix.Objects.isNull; @@ -71,8 +71,8 @@ public Record() { } /** - * @param length - * @param size + * @param length Tamanho do registro + * @param size Quantidade de fields que o registro deve conter. Deve ser um número natural > 0. */ public Record(Integer length, Integer size) { super(length, size); diff --git a/src/main/java/org/jrimum/texgit/type/component/RecordFactory.java b/src/main/java/org/jrimum/texgit/type/component/RecordFactory.java index 734d742..8088934 100644 --- a/src/main/java/org/jrimum/texgit/type/component/RecordFactory.java +++ b/src/main/java/org/jrimum/texgit/type/component/RecordFactory.java @@ -33,7 +33,7 @@ /** * @author Gilmar P.S.L. * - * @param + * @param Classe genérica de Record */ public interface RecordFactory { diff --git a/src/test/java/org/jrimum/texgit/type/component/TestFixedField.java b/src/test/java/org/jrimum/texgit/type/component/TestFixedField.java index fc24b3b..1059109 100644 --- a/src/test/java/org/jrimum/texgit/type/component/TestFixedField.java +++ b/src/test/java/org/jrimum/texgit/type/component/TestFixedField.java @@ -40,7 +40,7 @@ import java.text.SimpleDateFormat; import java.util.Date; -import org.apache.commons.lang.StringUtils; +import org.apache.commons.lang3.StringUtils; import org.jrimum.utilix.Dates; import org.jrimum.utilix.text.DecimalFormat; import org.junit.After;