From 8308c15177ee678bec639f6cbb19c51fff54b75c Mon Sep 17 00:00:00 2001
From: Bruno Augusto da Silva
* The following schema fragment specifies the expected content contained within
* this class.
- *
+ *
* The following schema fragment specifies the expected content contained within
* this class.
- *
+ *
* The following schema fragment specifies the expected content contained within
* this class.
- *
+ *
* The following schema fragment specifies the expected content contained within
* this class.
- *
+ *
- * 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.
*
* The following schema fragment specifies the expected content contained within
* this class.
- *
+ *
* Exemplo:
- *
* <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 @@
*
* <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 @@
*
* <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 @@
*
* <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 @@
*
*
*
* <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
+ *
* Se sideToFill == SideToFill.LEFT, o caracter especificado será adicionado à String
* no lado esquerdo até que o campo fique com o tamanho que foi definido.
*
+ * Informa a validade para a fixação de uma ou mais medidas. Exemplo:
*
*
* {
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..e64a9d9 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;
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..49ec7c6 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- * + * * @author Gilmar P.S.L * @author Misael Barreto * @author Rômulo Augusto 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..e5ff937 100644 --- a/src/main/java/org/jrimum/texgit/type/component/Fillers.java +++ b/src/main/java/org/jrimum/texgit/type/component/Fillers.java @@ -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) */ 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..fd8a6a0 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; 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..06e8707 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 + * @param size Tamanho */ 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. * - * @paramfiller = 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" *
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 9d5e37f..f04a0f5 100644
--- a/src/main/java/org/jrimum/texgit/type/Fixed.java
+++ b/src/main/java/org/jrimum/texgit/type/Fixed.java
@@ -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 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 49ec7c6..7d56506 100644
--- a/src/main/java/org/jrimum/texgit/type/component/Filler.java
+++ b/src/main/java/org/jrimum/texgit/type/component/Filler.java
@@ -79,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) {
@@ -88,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) {
@@ -98,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) {
@@ -117,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) {
@@ -136,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){
@@ -157,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){
@@ -220,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){
@@ -234,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) {
@@ -244,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 e5ff937..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)
*/
@@ -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 fd8a6a0..40dcb1f 100644
--- a/src/main/java/org/jrimum/texgit/type/component/FixedField.java
+++ b/src/main/java/org/jrimum/texgit/type/component/FixedField.java
@@ -41,7 +41,7 @@
/**
* @author Gilmar P.S.L.
*
- * @param