NameIDFormat (OpenSAML :: SAML Provider API 4.0.0 API)

All Superinterfaces:

SAMLObject, org.opensaml.core.xml.XMLObject, org.opensaml.core.xml.schema.XSURI
```
public interface NameIDFormat
extends SAMLObject, org.opensaml.core.xml.schema.XSURI
```
SAML 2.0 Metadata NameIDFormat.

Field Summary

Fields
Modifier and Type Field Description

static String DEFAULT_ELEMENT_LOCAL_NAME
Element name, no namespace.

static QName DEFAULT_ELEMENT_NAME
Default element name.
- Fields inherited from interface org.opensaml.core.xml.schema.XSURI
  TYPE_LOCAL_NAME, TYPE_NAME

Method Summary

All Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`default String`	`getFormat()`	Deprecated, for removal: This API element is subject to removal in a future version.
`default void`	`setFormat(String uri)`	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from interface org.opensaml.core.xml.XMLObject
detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Methods inherited from interface org.opensaml.core.xml.schema.XSURI
getURI, getValue, setURI, setValue

- Field Detail
  - DEFAULT_ELEMENT_LOCAL_NAME
```
@Nonnull
@NotEmpty
static final String DEFAULT_ELEMENT_LOCAL_NAME
```
    Element name, no namespace.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ELEMENT_NAME
```
@Nonnull
static final QName DEFAULT_ELEMENT_NAME
```
    Default element name.
- Method Detail
  - getFormat
```
@Deprecated(forRemoval=true,
            since="4.0.0")
@Nullable
default String getFormat()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    Gets the format of the NameID.
    
    Returns:
    
    the format of the NameID
  - setFormat
```
@Deprecated(forRemoval=true,
            since="4.0.0")
default void setFormat(@Nullable
                       String uri)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    Sets the format of the NameID.
    
    Parameters:
    
    uri - the format of the NameID