AbstractUserProfileBean.Attribute (Keycloak Docs Distribution 21.1.2 API)

java.lang.Object
- org.keycloak.forms.login.freemarker.model.AbstractUserProfileBean.Attribute

All Implemented Interfaces:

Comparable<AbstractUserProfileBean.Attribute>

Enclosing class:

AbstractUserProfileBean
```
public class AbstractUserProfileBean.Attribute
extends Object
implements Comparable<AbstractUserProfileBean.Attribute>
```
Info about user profile attribute available in Freemarker template.

Constructor Summary

Constructors
Constructor Description

Attribute(AttributeMetadata metadata)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(AbstractUserProfileBean.Attribute o)`
`Map<String,Object>`	`getAnnotations()`
`String`	`getAutocomplete()`	define value of the autocomplete attribute for html input tag.
`String`	`getDisplayName()`
`String`	`getGroup()`
`Map<String,Object>`	`getGroupAnnotations()`
`String`	`getGroupDisplayDescription()`
`String`	`getGroupDisplayHeader()`
`String`	`getName()`
`Map<String,Map<String,Object>>`	`getValidators()`	Get info about validators applied to attribute.
`String`	`getValue()`
`List<String>`	`getValues()`
`boolean`	`isReadOnly()`
`boolean`	`isRequired()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Attribute

public Attribute(AttributeMetadata metadata)

Method Detail
- getName
```
public String getName()
```
- getDisplayName
```
public String getDisplayName()
```
- getValue
```
public String getValue()
```
- getValues
```
public List<String> getValues()
```
- isRequired
```
public boolean isRequired()
```
- isReadOnly
```
public boolean isReadOnly()
```
- getAutocomplete
```
public String getAutocomplete()
```
  define value of the autocomplete attribute for html input tag. if null then no html input tag attribute is added
- getAnnotations
```
public Map<String,Object> getAnnotations()
```
- getValidators
```
public Map<String,Map<String,Object>> getValidators()
```
  Get info about validators applied to attribute.
  
  Returns:
  
  never null, map where key is validatorId and value is map with configuration for given validator (loaded from UserProfile configuration, never null)
- getGroup
```
public String getGroup()
```
- getGroupDisplayHeader
```
public String getGroupDisplayHeader()
```
- getGroupDisplayDescription
```
public String getGroupDisplayDescription()
```
- getGroupAnnotations
```
public Map<String,Object> getGroupAnnotations()
```
- compareTo
```
public int compareTo(AbstractUserProfileBean.Attribute o)
```
  Specified by:
  
  compareTo in interface Comparable<AbstractUserProfileBean.Attribute>