com.unboundid.scim.sdk

Class AttributePath

java.lang.Object

com.unboundid.scim.sdk.AttributePath

public class AttributePath
extends Object

This class represents a path to an attribute or sub-attribute. The path is a string comprising an schema URI (the SCIM core schema is assumed if absent), an attribute name, and an optional sub-attribute name.

Constructor Summary

Constructors

Constructor and Description
AttributePath(String attributeSchema, String attributeName, String subAttributeName) Create a new attribute path.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttributeName() Retrieve the name of the attribute.
String	getAttributeSchema() Retrieve the URI of the attribute schema.
String	getSubAttributeName() Retrieve the name of the sub-attribute, or null if absent.
static AttributePath	parse(String path) Parse an attribute path.
static AttributePath	parse(String path, String defaultSchema) Parse an attribute path.
String	toString()
void	toString(StringBuilder builder) Append the string representation of the attribute path to the provided buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributePath

public AttributePath(String attributeSchema,
             String attributeName,
             String subAttributeName)

Create a new attribute path.

Parameters:

attributeSchema - The URI of the attribute schema.

attributeName - The name of the attribute.

subAttributeName - The name of the sub-attribute, or null if absent.

Method Detail

parse

public static AttributePath parse(String path)

Parse an attribute path.

Parameters:

path - The attribute path.

Returns:

The parsed attribute path.

parse

public static AttributePath parse(String path,
                  String defaultSchema)

Parse an attribute path.

Parameters:

path - The attribute path.

defaultSchema - The default schema to assume for attributes that do not have the schema part of the urn specified. The 'id', 'externalId', and 'meta' attributes will always assume the SCIM Core schema.

Returns:

The parsed attribute path.

toString

public String toString()

Overrides:

toString in class Object

toString

public void toString(StringBuilder builder)

Append the string representation of the attribute path to the provided buffer.

Parameters:

builder - The buffer to which the string representation of the attribute path is to be appended.

getAttributeSchema

public String getAttributeSchema()

Retrieve the URI of the attribute schema.

Returns:

The URI of the attribute schema.

getAttributeName

public String getAttributeName()

Retrieve the name of the attribute.

Returns:

The name of the attribute.

getSubAttributeName

public String getSubAttributeName()

Retrieve the name of the sub-attribute, or null if absent.

Returns:

The name of the sub-attribute, or null if absent.