diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/annotation/NextView.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/annotation/NextView.java index bcfd08b..eac9254 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/annotation/NextView.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/annotation/NextView.java @@ -47,8 +47,12 @@ import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.Target; +/** + * Used to indicate which page to redirect after the execution of some method. + * + * @author SERPRO + */ -// TODO Este qualifier é realmente necessário? Verificar também na anotação PreviousView. @Inherited @Documented @Target({ TYPE, FIELD, METHOD, PARAMETER }) diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/annotation/PreviousView.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/annotation/PreviousView.java index 8a5dc5d..af57a8a 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/annotation/PreviousView.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/annotation/PreviousView.java @@ -47,6 +47,11 @@ import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.Target; +/** + * Used to indicate which page to return after the execution of some method. + * + * @author SERPRO + */ @Inherited @Documented @Target({ TYPE, FIELD, METHOD, PARAMETER }) diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractEditPageBean.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractEditPageBean.java index 97bc3bd..5bd0657 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractEditPageBean.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractEditPageBean.java @@ -48,6 +48,17 @@ import br.gov.frameworkdemoiselle.util.Parameter; import br.gov.frameworkdemoiselle.util.Reflections; import br.gov.frameworkdemoiselle.util.ResourceBundle; +/** + * Template Managed Bean class that implements the methods defined by the interface EditPageBean. + * + * @param + * bean object type + * @param + * bean id type + * + * @author SERPRO + * @see EditPageBean + */ public abstract class AbstractEditPageBean extends AbstractPageBean implements EditPageBean { private static final long serialVersionUID = 1L; diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractListPageBean.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractListPageBean.java index 107f78d..d97b2fe 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractListPageBean.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractListPageBean.java @@ -49,7 +49,17 @@ import javax.inject.Inject; import br.gov.frameworkdemoiselle.pagination.Pagination; import br.gov.frameworkdemoiselle.pagination.PaginationContext; import br.gov.frameworkdemoiselle.util.Reflections; - +/** + * Template Managed Bean class that implements the methods defined by the interface ListPageBean. + * + * @param + * bean object type + * @param + * bean id type + * + * @author SERPRO + * @see ListPageBean + */ public abstract class AbstractListPageBean extends AbstractPageBean implements ListPageBean { private static final long serialVersionUID = 1L; diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractPageBean.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractPageBean.java index a873768..8683111 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractPageBean.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/AbstractPageBean.java @@ -42,6 +42,12 @@ import javax.inject.Inject; import br.gov.frameworkdemoiselle.annotation.NextView; import br.gov.frameworkdemoiselle.annotation.PreviousView; +/** + * Template Managed Bean class that implements the methods defined by the interface PageBean. + * + * @author SERPRO + * @see PageBean + */ public abstract class AbstractPageBean implements PageBean { private static final long serialVersionUID = 1L; diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/EditPageBean.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/EditPageBean.java index 55581b0..a830e5b 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/EditPageBean.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/EditPageBean.java @@ -36,6 +36,15 @@ */ package br.gov.frameworkdemoiselle.template; +/** + * Interface that defines a contract of facilities that a page with funcionalities of insert, edit and delete could implement. + * + * @param + * bean object type + * + * @author SERPRO + * + */ public interface EditPageBean extends PageBean { String delete(); diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/ListPageBean.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/ListPageBean.java index 6770d99..32eb044 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/ListPageBean.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/ListPageBean.java @@ -41,6 +41,17 @@ import java.util.Map; import javax.faces.model.DataModel; +/** + * Interface that defines a contract of facilities that a page with the funcionality of list could implement. + * + * @param + * bean object type + * @param + * bean id type + * + * @author SERPRO + * + */ public interface ListPageBean extends PageBean { DataModel getDataModel(); diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/PageBean.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/PageBean.java index e485e9a..21954ba 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/PageBean.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/template/PageBean.java @@ -38,6 +38,12 @@ package br.gov.frameworkdemoiselle.template; import java.io.Serializable; +/** + * Interface that defines a contract of facilities that all pages could implement. + * + * @author SERPRO + * + */ public interface PageBean extends Serializable { String getCurrentView(); diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Faces.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Faces.java index 98c345f..d55580f 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Faces.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Faces.java @@ -55,6 +55,11 @@ import br.gov.frameworkdemoiselle.exception.ApplicationException; import br.gov.frameworkdemoiselle.message.Message; import br.gov.frameworkdemoiselle.message.SeverityType; +/** + * Utility class to insert messages in the FacesContext. + * + * @author SERPRO + * */ public class Faces { private Faces() { diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Locales.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Locales.java index 6b2f17f..9428043 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Locales.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Locales.java @@ -43,6 +43,11 @@ import javax.faces.context.FacesContext; import javax.inject.Inject; import javax.inject.Named; +/** + * Utility class to configure the Locale. + * + * @author SERPRO + * */ @Named public class Locales implements Serializable { diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/PageNotFoundException.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/PageNotFoundException.java index 2adee6b..2345415 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/PageNotFoundException.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/PageNotFoundException.java @@ -38,6 +38,12 @@ package br.gov.frameworkdemoiselle.util; import br.gov.frameworkdemoiselle.DemoiselleException; +/** + * + * Utility class that serves as the exception to be thrown when a page is not found. + * + * @author SERPRO + * */ public class PageNotFoundException extends DemoiselleException { private static final long serialVersionUID = 1L; diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Parameter.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Parameter.java index bcc4e87..cce5849 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Parameter.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Parameter.java @@ -40,6 +40,15 @@ import java.io.Serializable; import javax.faces.convert.Converter; +/** + * + * Interface that defines the methods to be implemented to get and set values on a parameter. + * + * @param + * bean object type + * + * @author SERPRO + * */ public interface Parameter { void setValue(T value); diff --git a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Redirector.java b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Redirector.java index ea94efa..2eb6e3b 100644 --- a/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Redirector.java +++ b/impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/util/Redirector.java @@ -47,6 +47,12 @@ import javax.faces.FacesException; import javax.faces.application.ViewHandler; import javax.faces.context.FacesContext; +/** + * + * Utility class to redirect determined page to another one. + * + * @author SERPRO + * */ public class Redirector { private Redirector() { -- libgit2 0.21.2