Class ResourcePathDeclaration.Component

java.lang.Object

com.soklet.ResourcePathDeclaration.Component

Enclosing class:

ResourcePathDeclaration

@Immutable
public static final class ResourcePathDeclaration.Component
extends Object

Represents a /-delimited part of a ResourcePathDeclaration.

For example, given the path declaration /languages/{languageId}:

• Component 0 would have type LITERAL and value languages
• Component 1 would have type PLACEHOLDER and value languageId

You may obtain instances via the with(String, ComponentType) factory method.

Note: this type is not normally used by Soklet applications unless they choose to implement a custom ResourceMethodResolver.

Author:

Mark Allen

See Also:

• ResourcePathDeclaration

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
ResourcePathDeclaration.ComponentType	getType()	What type of resource path declaration component is this?
String	getValue()	What is the value of this resource path declaration component?
int	hashCode()
String	toString()
static ResourcePathDeclaration.Component	with(String value, ResourcePathDeclaration.ComponentType type)	Acquires a ResourcePathDeclaration.Component instance given a value and type.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

with

@Nonnull
public static ResourcePathDeclaration.Component with(@Nonnull
 String value,
 @Nonnull
 ResourcePathDeclaration.ComponentType type)

Acquires a ResourcePathDeclaration.Component instance given a value and type.

Parameters:

value - the value of this component

type - the type of this component (literal or placeholder)

Returns:

a ResourcePathDeclaration.Component instance

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getValue

@Nonnull
public String getValue()

What is the value of this resource path declaration component?

Note that the value of a ResourcePathDeclaration.ComponentType.PLACEHOLDER component does not include enclosing braces. For example, given the path declaration /languages/{languageId}, the component at index 1 would have value languageId, not {languageId}.

Returns:

the value of this component

getType

@Nonnull
public ResourcePathDeclaration.ComponentType getType()

What type of resource path declaration component is this?

Returns:

the type of component, e.g. ResourcePathDeclaration.ComponentType.LITERAL or ResourcePathDeclaration.ComponentType.PLACEHOLDER