DefaultUrlMappingEvaluator.UrlMappingBuilder (Grace Framework

org.grails.web.mapping.DefaultUrlMappingEvaluator.UrlMappingBuilder

```
@SuppressWarnings("rawtypes")
protected class DefaultUrlMappingEvaluator.UrlMappingBuilder
extends GroovyObjectSupport
```
A modal builder that constructs a UrlMapping instances by executing a closure. The class overrides getProperty(name) and allows the substitution of GString values with the * wildcard.

invokeMethod(methodName, args) is also overriden for the creation of each UrlMapping instance

Constructor Summary

Constructors
Constructor and description
`UrlMappingBuilder(Binding binding)`
`protected UrlMappingBuilder(UrlMappingBuilder parent)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`collection(Closure callable)` Define Url mapping collections that are nested directly below the parent resource (without the id)
	`protected UrlMapping`	`createCreateActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, ConstrainedProperty[] constraintArray)`
	`protected UrlMapping`	`createDeleteActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`protected UrlMapping`	`createDeleteActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`protected UrlMapping`	`createEditActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, ConstrainedProperty[] constraintArray)`
	`protected UrlMapping`	`createEditActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`protected UrlMapping`	`createIndexActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`protected UrlMapping`	`createPatchActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`protected UrlMapping`	`createPatchActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`protected void`	`createResourceRestfulMappings(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList, List<String> includes)`
	`protected UrlMapping`	`createSaveActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`protected UrlMapping`	`createShowActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`protected UrlMapping`	`createShowActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`protected void`	`createSingleResourceRestfulMappings(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList, List<String> includes)` Takes a controller and creates the necessary URL mappings for a singular RESTful resource
	`protected UrlMapping`	`createUpdateActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`protected UrlMapping`	`createUpdateActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)`
	`public UrlMapping`	`delete(Map arguments, String uri, Closure callable)` Matches the DELETE method
	`public UrlMapping`	`delete(Map arguments, String uri)`
	`public UrlMapping`	`delete(RegexUrlMapping regexUrlMapping)`
	`public UrlMapping`	`get(Map arguments, String uri, Closure callable)` Matches the GET method
	`public UrlMapping`	`get(Map arguments, String uri)`
	`public UrlMapping`	`get(RegexUrlMapping regexUrlMapping)`
	`public Object`	`getAction()`
	`public ApplicationContext`	`getApplicationContext()`
	`public Object`	`getController()`
	`public Object`	`getException()`
	`public GrailsApplication`	`getGrailsApplication()`
	`protected MetaMappingInfo`	`getMetaMappingInfo()`
	`public Object`	`getMethod()`
	`public Object`	`getNamespace()`
	`public Object`	`getPlugin()`
	`public Object`	`getProperty(String name)`
	`public Object`	`getRedirectInfo()`
	`public ServletContext`	`getServletContext()`
	`public Object`	`getUri()`
	`public List<UrlMapping>`	`getUrlMappings()`
	`public Object`	`getView()`
	`public void`	`group(String uri, Closure mappings)` Define a group
	`public UrlMapping`	`head(Map arguments, String uri, Closure callable)` Matches the HEAD method
	`public UrlMapping`	`head(Map arguments, String uri)`
	`public UrlMapping`	`head(RegexUrlMapping regexUrlMapping)`
	`public Object`	`invokeMethod(String methodName, Object arg)`
	`public void`	`members(Closure callable)` Define Url mapping members that are nested directly below the parent resource and resource id
	`public void`	`name(Map<String, UrlMapping> m)`
	`public UrlMapping`	`options(Map arguments, String uri, Closure callable)` Matches the OPTIONS method
	`public UrlMapping`	`options(Map arguments, String uri)`
	`public UrlMapping`	`options(RegexUrlMapping regexUrlMapping)`
	`public UrlMapping`	`patch(Map arguments, String uri, Closure callable)` Matches the PATCH method
	`public UrlMapping`	`patch(Map arguments, String uri)`
	`public UrlMapping`	`patch(RegexUrlMapping regexUrlMapping)`
	`public UrlMapping`	`post(Map arguments, String uri, Closure callable)` Matches the POST method
	`public UrlMapping`	`post(Map arguments, String uri)`
	`public UrlMapping`	`post(RegexUrlMapping regexUrlMapping)`
	`protected MetaMappingInfo`	`pushNewMetaMappingInfo()`
	`public UrlMapping`	`put(Map arguments, String uri, Closure callable)` Matches the PUT method
	`public UrlMapping`	`put(Map arguments, String uri)`
	`public UrlMapping`	`put(RegexUrlMapping regexUrlMapping)`
	`public void`	`setAction(Object action)`
	`public void`	`setController(Object controller)`
	`public void`	`setException(Object exception)`
	`public void`	`setMethod(Object method)`
	`public void`	`setNamespace(Object namespace)`
	`public void`	`setPlugin(Object plugin)`
	`public void`	`setRedirectInfo(Object redirectInfo)`
	`public void`	`setUri(Object uri)`
	`public void`	`setView(String viewName)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GroovyObjectSupport`	`equals, getClass, getMetaClass, getProperty, hashCode, invokeMethod, notify, notifyAll, setMetaClass, setProperty, toString, wait, wait, wait`

- Constructor Detail
  - public UrlMappingBuilder(Binding binding)
  - protected UrlMappingBuilder(UrlMappingBuilder parent)
- Method Detail
  - public void collection(Closure callable)
    
    Define Url mapping collections that are nested directly below the parent resource (without the id)
    Parameters:
    callable - The callable
  - protected UrlMapping createCreateActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, ConstrainedProperty[] constraintArray)
  - protected UrlMapping createDeleteActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - protected UrlMapping createDeleteActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - protected UrlMapping createEditActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, ConstrainedProperty[] constraintArray)
  - protected UrlMapping createEditActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - protected UrlMapping createIndexActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - protected UrlMapping createPatchActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - protected UrlMapping createPatchActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - protected void createResourceRestfulMappings(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList, List<String> includes)
  - protected UrlMapping createSaveActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - protected UrlMapping createShowActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - protected UrlMapping createShowActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - protected void createSingleResourceRestfulMappings(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList, List<String> includes)
    
    Takes a controller and creates the necessary URL mappings for a singular RESTful resource
    Parameters:
    controllerName - The controller name
    pluginName - The name of the plugin
    namespace
    version
    urlData - The urlData instance
    includes
  - protected UrlMapping createUpdateActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - protected UrlMapping createUpdateActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)
  - @SuppressWarnings("unchecked")
    public UrlMapping delete(Map arguments, String uri, Closure callable)
    
    Matches the DELETE method
    Parameters:
    arguments - The arguments
    uri - The URI
    Returns:
    the UrlMapping
  - public UrlMapping delete(Map arguments, String uri)
  - public UrlMapping delete(RegexUrlMapping regexUrlMapping)
  - @SuppressWarnings("unchecked")
    public UrlMapping get(Map arguments, String uri, Closure callable)
    
    Matches the GET method
    Parameters:
    arguments - The arguments
    uri - The URI
    callable - the customizer
    Returns:
    the UrlMapping
  - public UrlMapping get(Map arguments, String uri)
  - public UrlMapping get(RegexUrlMapping regexUrlMapping)
  - public Object getAction()
  - public ApplicationContext getApplicationContext()
  - public Object getController()
  - public Object getException()
  - public GrailsApplication getGrailsApplication()
  - protected MetaMappingInfo getMetaMappingInfo()
  - public Object getMethod()
  - public Object getNamespace()
  - public Object getPlugin()
  - @Override
    public Object getProperty(String name)
  - public Object getRedirectInfo()
  - public ServletContext getServletContext()
  - public Object getUri()
  - public List<UrlMapping> getUrlMappings()
  - public Object getView()
  - public void group(String uri, Closure mappings)
    
    Define a group
    Parameters:
    uri - The URI
    mappings - The mappings
  - @SuppressWarnings("unchecked")
    public UrlMapping head(Map arguments, String uri, Closure callable)
    
    Matches the HEAD method
    Parameters:
    arguments - The arguments
    uri - The URI
    Returns:
    the UrlMapping
  - public UrlMapping head(Map arguments, String uri)
  - public UrlMapping head(RegexUrlMapping regexUrlMapping)
  - @Override
    public Object invokeMethod(String methodName, Object arg)
  - public void members(Closure callable)
    
    Define Url mapping members that are nested directly below the parent resource and resource id
    Parameters:
    callable - The callable
  - public void name(Map<String, UrlMapping> m)
  - @SuppressWarnings("unchecked")
    public UrlMapping options(Map arguments, String uri, Closure callable)
    
    Matches the OPTIONS method
    Parameters:
    arguments - The arguments
    uri - The URI
    Returns:
    the UrlMapping
  - public UrlMapping options(Map arguments, String uri)
  - public UrlMapping options(RegexUrlMapping regexUrlMapping)
  - @SuppressWarnings("unchecked")
    public UrlMapping patch(Map arguments, String uri, Closure callable)
    
    Matches the PATCH method
    Parameters:
    arguments - The arguments
    uri - The URI
    Returns:
    the UrlMapping
  - public UrlMapping patch(Map arguments, String uri)
  - public UrlMapping patch(RegexUrlMapping regexUrlMapping)
  - @SuppressWarnings("unchecked")
    public UrlMapping post(Map arguments, String uri, Closure callable)
    
    Matches the POST method
    Parameters:
    arguments - The arguments
    uri - The URI
    Returns:
    the UrlMapping
  - public UrlMapping post(Map arguments, String uri)
  - public UrlMapping post(RegexUrlMapping regexUrlMapping)
  - protected MetaMappingInfo pushNewMetaMappingInfo()
  - @SuppressWarnings("unchecked")
    public UrlMapping put(Map arguments, String uri, Closure callable)
    
    Matches the PUT method
    Parameters:
    arguments - The arguments
    uri - The URI
    Returns:
    the UrlMapping
  - public UrlMapping put(Map arguments, String uri)
  - public UrlMapping put(RegexUrlMapping regexUrlMapping)
  - public void setAction(Object action)
  - public void setController(Object controller)
  - public void setException(Object exception)
  - public void setMethod(Object method)
  - public void setNamespace(Object namespace)
  - public void setPlugin(Object plugin)
  - public void setRedirectInfo(Object redirectInfo)
  - public void setUri(Object uri)
  - public void setView(String viewName)

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class DefaultUrlMappingEvaluator.UrlMappingBuilder

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public UrlMappingBuilder(Binding binding)

protected UrlMappingBuilder(UrlMappingBuilder parent)

Method Detail

public void collection(Closure callable)

protected UrlMapping createCreateActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, ConstrainedProperty[] constraintArray)

protected UrlMapping createDeleteActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

protected UrlMapping createDeleteActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

protected UrlMapping createEditActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, ConstrainedProperty[] constraintArray)

protected UrlMapping createEditActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

protected UrlMapping createIndexActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

protected UrlMapping createPatchActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

protected UrlMapping createPatchActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

protected void createResourceRestfulMappings(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList, List<String> includes)

protected UrlMapping createSaveActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

protected UrlMapping createShowActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

protected UrlMapping createShowActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

protected void createSingleResourceRestfulMappings(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList, List<String> includes)

protected UrlMapping createUpdateActionResourceRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

protected UrlMapping createUpdateActionResourcesRestfulMapping(String controllerName, Object pluginName, Object namespace, String version, UrlMappingData urlData, List<ConstrainedProperty> constrainedList)

@SuppressWarnings("unchecked")public UrlMapping delete(Map arguments, String uri, Closure callable)

public UrlMapping delete(Map arguments, String uri)

public UrlMapping delete(RegexUrlMapping regexUrlMapping)

@SuppressWarnings("unchecked")public UrlMapping get(Map arguments, String uri, Closure callable)

public UrlMapping get(Map arguments, String uri)

public UrlMapping get(RegexUrlMapping regexUrlMapping)

public Object getAction()

public ApplicationContext getApplicationContext()

public Object getController()

public Object getException()

public GrailsApplication getGrailsApplication()

protected MetaMappingInfo getMetaMappingInfo()

public Object getMethod()

public Object getNamespace()

public Object getPlugin()

@Overridepublic Object getProperty(String name)

public Object getRedirectInfo()

public ServletContext getServletContext()

public Object getUri()

public List<UrlMapping> getUrlMappings()

public Object getView()

public void group(String uri, Closure mappings)

@SuppressWarnings("unchecked")public UrlMapping head(Map arguments, String uri, Closure callable)

public UrlMapping head(Map arguments, String uri)

public UrlMapping head(RegexUrlMapping regexUrlMapping)

@Overridepublic Object invokeMethod(String methodName, Object arg)

public void members(Closure callable)

public void name(Map<String, UrlMapping> m)

@SuppressWarnings("unchecked")public UrlMapping options(Map arguments, String uri, Closure callable)

public UrlMapping options(Map arguments, String uri)

public UrlMapping options(RegexUrlMapping regexUrlMapping)

@SuppressWarnings("unchecked")public UrlMapping patch(Map arguments, String uri, Closure callable)

public UrlMapping patch(Map arguments, String uri)

public UrlMapping patch(RegexUrlMapping regexUrlMapping)

@SuppressWarnings("unchecked")public UrlMapping post(Map arguments, String uri, Closure callable)

public UrlMapping post(Map arguments, String uri)

public UrlMapping post(RegexUrlMapping regexUrlMapping)

protected MetaMappingInfo pushNewMetaMappingInfo()

@SuppressWarnings("unchecked")public UrlMapping put(Map arguments, String uri, Closure callable)

public UrlMapping put(Map arguments, String uri)

public UrlMapping put(RegexUrlMapping regexUrlMapping)

public void setAction(Object action)

public void setController(Object controller)

public void setException(Object exception)

public void setMethod(Object method)

public void setNamespace(Object namespace)

public void setPlugin(Object plugin)

public void setRedirectInfo(Object redirectInfo)

public void setUri(Object uri)

public void setView(String viewName)

@SuppressWarnings("unchecked")
public UrlMapping delete(Map arguments, String uri, Closure callable)

@SuppressWarnings("unchecked")
public UrlMapping get(Map arguments, String uri, Closure callable)

@Override
public Object getProperty(String name)

@SuppressWarnings("unchecked")
public UrlMapping head(Map arguments, String uri, Closure callable)

@Override
public Object invokeMethod(String methodName, Object arg)

@SuppressWarnings("unchecked")
public UrlMapping options(Map arguments, String uri, Closure callable)

@SuppressWarnings("unchecked")
public UrlMapping patch(Map arguments, String uri, Closure callable)

@SuppressWarnings("unchecked")
public UrlMapping post(Map arguments, String uri, Closure callable)

@SuppressWarnings("unchecked")
public UrlMapping put(Map arguments, String uri, Closure callable)