Module io.inverno.mod.web.compiler
Package io.inverno.mod.web.compiler.spi

Class WebParameterQualifiedName

java.lang.Object
io.inverno.core.compiler.spi.QualifiedName
io.inverno.mod.web.compiler.spi.WebParameterQualifiedName
public class WebParameterQualifiedName extends io.inverno.core.compiler.spi.QualifiedName

A qualified name identifying a parameter in a web route.

Since:
1.0
Author:
Jeremy Kuhn

  • Field Summary

    Fields inherited from class io.inverno.core.compiler.spi.QualifiedName

    SEPARATOR

  • Constructor Summary

    Constructors
    Constructor
    Description
    WebParameterQualifiedName​(WebRouteQualifiedName routeQName, String name)
    Creates a web parameter qualified name with the specified route qualified name and parameter name.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getParameterName()
    Returns the parameter name.
    WebRouteQualifiedName
    getRouteQName()
    Returns the route qualified name.
    String
    getSimpleValue()
     
    static WebParameterQualifiedName
    valueOf​(io.inverno.core.compiler.spi.BeanQualifiedName controllerQName, String qname)
    Creates a web parameter qualified name from the specified bean qualified name of the web controller and the specified raw value of the form <routeName>:<parameterName> where <routeName> and <parameterName> are valid Java names.
    static WebParameterQualifiedName
    valueOf​(String qname)
    Creates a web parameter qualified name from the specified raw value of the form WebRouteQualifiedName():<parameterName> where <parameterName> is a valid Java name.

    Methods inherited from class io.inverno.core.compiler.spi.QualifiedName

    equals, getValue, hashCode, normalize, toString, validateQualifiedNamePart

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • WebParameterQualifiedName

      public WebParameterQualifiedName​(WebRouteQualifiedName routeQName, String name) throws io.inverno.core.compiler.spi.QualifiedNameFormatException

      Creates a web parameter qualified name with the specified route qualified name and parameter name.

      Parameters:
      routeQName - the route qualified name
      name - the parameter name
      Throws:
      io.inverno.core.compiler.spi.QualifiedNameFormatException - if the specified parameter name is invalid

  • Method Details

    • getSimpleValue

      public String getSimpleValue()
      Specified by:
      getSimpleValue in class io.inverno.core.compiler.spi.QualifiedName

    • getRouteQName

      public WebRouteQualifiedName getRouteQName()

      Returns the route qualified name.

      Returns:
      the route qualified name

    • getParameterName

      public String getParameterName()

      Returns the parameter name.

      Returns:
      the parameter name

    • valueOf

      public static WebParameterQualifiedName valueOf​(String qname) throws io.inverno.core.compiler.spi.QualifiedNameFormatException

      Creates a web parameter qualified name from the specified raw value of the form WebRouteQualifiedName():<parameterName> where <parameterName> is a valid Java name.

      Parameters:
      qname - a raw qualified name
      Returns:
      a web parameter qualified name
      Throws:
      io.inverno.core.compiler.spi.QualifiedNameFormatException - if the specified value is not a web parameter qualified name

    • valueOf

      public static WebParameterQualifiedName valueOf​(io.inverno.core.compiler.spi.BeanQualifiedName controllerQName, String qname) throws io.inverno.core.compiler.spi.QualifiedNameFormatException

      Creates a web parameter qualified name from the specified bean qualified name of the web controller and the specified raw value of the form <routeName>:<parameterName> where <routeName> and <parameterName> are valid Java names.

      Parameters:
      controllerQName - a web controller qualified name
      qname - a raw qualified name
      Returns:
      a web parameter qualified name
      Throws:
      io.inverno.core.compiler.spi.QualifiedNameFormatException - if the specified value is not a web parameter qualified name