ResourceName (endpoints-control 1.0.5 API)

java.lang.Object
- com.google.api.control.model.ResourceName

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.String>
```
@Beta
public class ResourceName
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.String>
```
Class for representing and working with resource names.
A resource name is represented by PathTemplate, an assignment to variables in the template, and an optional endpoint. The ResourceName class implements the map interface (unmodifiable) to work with the variable assignments, and has methods to reproduce the string representation of the name, to construct new names, and to dereference names into resources.
As a resource name essentially represents a match of a path template against a string, it can be also used for other purposes than naming resources. However, not all provided methods may make sense in all applications.
Usage examples:
```
   PathTemplate template = PathTemplate.create("shelves/*/books/*");
   ResourceName resourceName = ResourceName.create(template, "shelves/s1/books/b1");
   assert resourceName.get("$1").equals("b1");
   assert resourceName.parentName().toString().equals("shelves/s1/books");
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ResourceName.Resolver
Represents a resource name resolver which can be registered with this class.
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ResourceName.Resolver` Represents a resource name resolver which can be registered with this class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clear()` Deprecated.
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`static ResourceName`	`create(PathTemplate template, java.util.Map<java.lang.String,java.lang.String> values)` Creates a new resource name from a template and a value assignment for variables.
`static ResourceName`	`create(PathTemplate template, java.lang.String path)` Creates a new resource name based on given template and path.
`static ResourceName`	`createFromFullName(PathTemplate template, java.lang.String path)` Creates a new resource name based on given template and path, where the path contains an endpoint.
`java.lang.String`	`endpoint()` Returns the endpoint of this resource name, or null if none is defined.
`java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>`	`entrySet()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`get(java.lang.Object key)`
`boolean`	`hasEndpoint()` Checks whether the resource name has an endpoint.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Set<java.lang.String>`	`keySet()`
`ResourceName`	`parentName()` Returns the parent resource name.
`java.lang.String`	`put(java.lang.String key, java.lang.String value)` Deprecated.
`void`	`putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m)` Deprecated.
`static void`	`registerResourceNameResolver(ResourceName.Resolver resolver)` Sets the resource name resolver which is used by the `resolve(Class, String)` method.
`java.lang.String`	`remove(java.lang.Object key)` Deprecated.
`<T> T`	`resolve(java.lang.Class<T> resourceType, java.lang.String version)` Attempts to resolve a resource name into a resource, by calling the associated API.
`int`	`size()`
`boolean`	`startsWith(ResourceName parentName)` Returns true of the resource name starts with the parent resource name, i.e.
`PathTemplate`	`template()` Gets the template associated with this resource name.
`java.lang.String`	`toString()`
`java.util.Collection<java.lang.String>`	`values()`
`ResourceName`	`withEndpoint(java.lang.String endpoint)` Returns a resource name with specified endpoint.

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Method Detail
  - registerResourceNameResolver
```
public static void registerResourceNameResolver(ResourceName.Resolver resolver)
```
    Sets the resource name resolver which is used by the resolve(Class, String) method. By default, no resolver is registered.
  - create
```
public static ResourceName create(PathTemplate template,
                                  java.lang.String path)
```
    Creates a new resource name based on given template and path. The path must match the template, otherwise null is returned.
    
    Throws:
    
    ValidationException - if the path does not match the template.
  - create
```
public static ResourceName create(PathTemplate template,
                                  java.util.Map<java.lang.String,java.lang.String> values)
```
    Creates a new resource name from a template and a value assignment for variables.
    
    Throws:
    
    ValidationException - if not all variables in the template are bound.
  - createFromFullName
```
@Nullable
public static ResourceName createFromFullName(PathTemplate template,
                                                        java.lang.String path)
```
    Creates a new resource name based on given template and path, where the path contains an endpoint. If the path does not match, null is returned.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in interface java.util.Map<java.lang.String,java.lang.String>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<java.lang.String,java.lang.String>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - template
```
public PathTemplate template()
```
    Gets the template associated with this resource name.
  - hasEndpoint
```
public boolean hasEndpoint()
```
    Checks whether the resource name has an endpoint.
  - endpoint
```
@Nullable
public java.lang.String endpoint()
```
    Returns the endpoint of this resource name, or null if none is defined.
  - withEndpoint
```
public ResourceName withEndpoint(java.lang.String endpoint)
```
    Returns a resource name with specified endpoint.
  - parentName
```
public ResourceName parentName()
```
    Returns the parent resource name. For example, if the name is shelves/s1/books/b1, the parent is shelves/s1/books.
  - startsWith
```
public boolean startsWith(ResourceName parentName)
```
    Returns true of the resource name starts with the parent resource name, i.e. is a child of the parent.
  - resolve
```
public <T> T resolve(java.lang.Class<T> resourceType,
                     @Nullable
                     java.lang.String version)
```
    Attempts to resolve a resource name into a resource, by calling the associated API. The resource name must have an endpoint. An optional version can be specified to determine in which version of the API to call.
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.String,java.lang.String>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<java.lang.String,java.lang.String>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<java.lang.String,java.lang.String>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.String,java.lang.String>
  - get
```
public java.lang.String get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.String,java.lang.String>
  - put
```
@Deprecated
public java.lang.String put(java.lang.String key,
                                        java.lang.String value)
```
    Deprecated.
    
    Specified by:
    
    put in interface java.util.Map<java.lang.String,java.lang.String>
  - remove
```
@Deprecated
public java.lang.String remove(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.String,java.lang.String>
  - putAll
```
@Deprecated
public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m)
```
    Deprecated.
    
    Specified by:
    
    putAll in interface java.util.Map<java.lang.String,java.lang.String>
  - clear
```
@Deprecated
public void clear()
```
    Deprecated.
    
    Specified by:
    
    clear in interface java.util.Map<java.lang.String,java.lang.String>
  - keySet
```
public java.util.Set<java.lang.String> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.String,java.lang.String>
  - values
```
public java.util.Collection<java.lang.String> values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.String,java.lang.String>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<java.lang.String,java.lang.String>

Class ResourceName

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Method Detail

registerResourceNameResolver

create

create

createFromFullName

toString

equals

hashCode

template

hasEndpoint

endpoint

withEndpoint

parentName

startsWith

resolve

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet