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

Class WebRouteQualifiedName

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

A qualified name identifying a web route in a web controller or a web router configurer.

Since:
1.0
Author:
Jeremy Kuhn

  • Field Summary

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

    SEPARATOR

  • Constructor Summary

    Constructors
    Constructor
    Description
    WebRouteQualifiedName​(io.inverno.core.compiler.spi.BeanQualifiedName controllerQName, String name)
    Creates a web route qualified name with the specified controller qualified name and route name.
    WebRouteQualifiedName​(String name)
    Creates a web route qualified name with the specified name.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.inverno.core.compiler.spi.BeanQualifiedName
    getControllerQName()
    Returns the controller qualified name.
    String
    getName()
    Returns the route name.
    String
    getSimpleValue()
     
    static WebRouteQualifiedName
    valueOf​(io.inverno.core.compiler.spi.ModuleQualifiedName moduleQName, String qname)
    Creates a bean socket qualified name from the specified module qualified name and the specified raw value of the form <controllerName>:<routeName> where <controllerName> and <routeName> are valid Java names.
    static WebRouteQualifiedName
    valueOf​(String qname)
    Creates a web route qualified name from the specified raw value of the form WebControllerQualifiedName():<routeName> where <routeName> 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

    • WebRouteQualifiedName

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

      Creates a web route qualified name with the specified name.

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

    • WebRouteQualifiedName

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

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

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

  • Method Details

    • getSimpleValue

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

    • getControllerQName

      public io.inverno.core.compiler.spi.BeanQualifiedName getControllerQName()

      Returns the controller qualified name.

      Returns:
      the bean qualified name of the controller

    • getName

      public String getName()

      Returns the route name.

      Returns:
      the route name

    • valueOf

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

      Creates a web route qualified name from the specified raw value of the form WebControllerQualifiedName():<routeName> where <routeName> is a valid Java name.

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

    • valueOf

      public static WebRouteQualifiedName valueOf​(io.inverno.core.compiler.spi.ModuleQualifiedName moduleQName, String qname) throws io.inverno.core.compiler.spi.QualifiedNameFormatException

      Creates a bean socket qualified name from the specified module qualified name and the specified raw value of the form <controllerName>:<routeName> where <controllerName> and <routeName> are valid Java names.

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