Package com.vaadin.copilot

Record Class NewRouteTemplateHandler.FlowTemplateRequest

java.lang.Object
java.lang.Record
com.vaadin.copilot.NewRouteTemplateHandler.FlowTemplateRequest
Record Components:
packageName - Package name where file will be located. e.g. com.vaadin.project.views
route - Route url of the view
title - Title of the page which will be used for @PageTitle
className - Java class name of the file. e.g. HelloWorldView for HelloWorldView.java
accessRequirement - Access requirement parameters that are entered from UI
layoutClass - Layout class that view is extended from. Might be null.
templateName - Template file name. e.g. HelloWorldView.java
templateData - data for the selected template, or null
addToMenu - whether to add the view to an automatically generated menu
Enclosing class:
NewRouteTemplateHandler
public static record NewRouteTemplateHandler.FlowTemplateRequest(String packageName, String route, String title, String className, AccessRequirement accessRequirement, Class<?> layoutClass, String templateName, String templateData, boolean addToMenu) extends Record
Contains information to generate new Flow view

  • Constructor Details

    • FlowTemplateRequest

      public FlowTemplateRequest(String packageName, String route, String title, String className, AccessRequirement accessRequirement, Class<?> layoutClass, String templateName, String templateData, boolean addToMenu)
      Creates an instance of a FlowTemplateRequest record class.
      Parameters:
      packageName - the value for the packageName record component
      route - the value for the route record component
      title - the value for the title record component
      className - the value for the className record component
      accessRequirement - the value for the accessRequirement record component
      layoutClass - the value for the layoutClass record component
      templateName - the value for the templateName record component
      templateData - the value for the templateData record component
      addToMenu - the value for the addToMenu record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • packageName

      public String packageName()
      Returns the value of the packageName record component.
      Returns:
      the value of the packageName record component

    • route

      public String route()
      Returns the value of the route record component.
      Returns:
      the value of the route record component

    • title

      public String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component

    • className

      public String className()
      Returns the value of the className record component.
      Returns:
      the value of the className record component

    • accessRequirement

      public AccessRequirement accessRequirement()
      Returns the value of the accessRequirement record component.
      Returns:
      the value of the accessRequirement record component

    • layoutClass

      public Class<?> layoutClass()
      Returns the value of the layoutClass record component.
      Returns:
      the value of the layoutClass record component

    • templateName

      public String templateName()
      Returns the value of the templateName record component.
      Returns:
      the value of the templateName record component

    • templateData

      public String templateData()
      Returns the value of the templateData record component.
      Returns:
      the value of the templateData record component

    • addToMenu

      public boolean addToMenu()
      Returns the value of the addToMenu record component.
      Returns:
      the value of the addToMenu record component