io.inverno.mod.web.compiler.spi.WebControllerInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of inverno-web-compiler Show documentation

Inverno web compiler module providing an Inverno compiler plugin to aggregate module's web routes and web router configurers into a single web router configurer

There is a newer version: 1.11.0

Show newest version

/*
 * Copyright 2021 Jeremy KUHN
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.inverno.mod.web.compiler.spi;

import io.inverno.core.compiler.spi.BeanQualifiedName;
import io.inverno.core.compiler.spi.Info;
import javax.lang.model.element.TypeElement;
import javax.lang.model.type.DeclaredType;

/**
 * 
 * Describes a web controller.
 * 
 * 
 * @author Jeremy Kuhn
 * @since 1.0
 */
public interface WebControllerInfo extends Info {

	@Override
	BeanQualifiedName getQualifiedName();
	
	/**
	 * 
	 * Returns the type element defining the web controller.
	 * 
	 * 
	 * @return a type element
	 */
	TypeElement getElement();
	
	/**
	 * 
	 * Returns the type of the web controller.
	 * 
	 * 
	 * @return a type
	 */
	DeclaredType getType();
	
	/**
	 * 
	 * Returns the web controller root path.
	 * 
	 * 
	 * @return an absolute normalized path
	 */
	String getRootPath();
	
	/**
	 * 
	 * Returns the web routes defined in the web controller.
	 * 
	 * 
	 * @return an array of web route info
	 */
	WebRouteInfo[] getRoutes();
}