SubResources (OpenAM Server Only 7.3.1 Documentation)

java.lang.Object
- org.forgerock.api.models.SubResources

public final class SubResources
extends Object

Sub-resources of a resource are declared here.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SubResources.Builder
Builder to help construct the SubResources.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`Resource`	`get(String name)`	Gets the `Resource` for a given sub-resource name.
`Set<String>`	`getNames()`	Returns all sub-resource names.
`Map<String,Resource>`	`getSubResources()`	Gets a `Map` of paths to `Resource`s.
`int`	`hashCode()`
`static SubResources.Builder`	`subresources()`	Create a new Builder for sub-resources.

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

- Method Detail
  - getSubResources
```
public Map<String,Resource> getSubResources()
```
    Gets a Map of paths to Resources.
    
    Returns:
    
    The Map.
  - get
```
public Resource get(String name)
```
    Gets the Resource for a given sub-resource name.
    
    Parameters:
    
    name - Sub-resource name
    
    Returns:
    
    Resource or null if does-not-exist.
  - getNames
```
public Set<String> getNames()
```
    Returns all sub-resource names.
    
    Returns:
    
    The names.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - subresources
```
public static SubResources.Builder subresources()
```
    Create a new Builder for sub-resources.
    
    Returns:
    
    Builder