updated API description
This commit is contained in:
@ -22,23 +22,30 @@ import javax.faces.view.facelets.FaceletContext;
|
||||
import javax.faces.view.facelets.TagConfig;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* <div>
|
||||
* Tag used to print out the String value of a user's default principal, or a
|
||||
* specific principal as specified by the tag's attributes.</p>
|
||||
* specific principal as specified by the tag's attributes.
|
||||
* </div>
|
||||
*
|
||||
* <p>
|
||||
* If no attributes are specified, the tag prints out the <tt>toString()</tt>
|
||||
* value of the user's default principal. If the <tt>type</tt> attribute is
|
||||
* <div>
|
||||
* If no attributes are specified, the tag prints out the <b>toString()</b>
|
||||
* value of the user's default principal. If the <b>type</b> attribute is
|
||||
* specified, the tag looks for a principal with the given type. If the
|
||||
* <tt>property</tt> attribute is specified, the tag prints the string value of
|
||||
* <b>property</b> attribute is specified, the tag prints the string value of
|
||||
* the specified property of the principal. If no principal is found or the user
|
||||
* is not authenticated, the tag displays nothing unless a <tt>defaultValue</tt>
|
||||
* is specified.</p>
|
||||
* is not authenticated, the tag displays nothing unless a <b>defaultValue</b>
|
||||
* is specified.
|
||||
* </div>
|
||||
*
|
||||
* @author Joern Muehlencord (joern at muehlencord.de)
|
||||
*/
|
||||
public class PrincipalTag extends AbstractTag {
|
||||
|
||||
/**
|
||||
* creates a new principal tag
|
||||
*
|
||||
* @param config the configuration to use
|
||||
*/
|
||||
public PrincipalTag(TagConfig config) {
|
||||
super(config);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user