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

Go to download
/*
 * 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.QualifiedName;
import io.inverno.core.compiler.spi.QualifiedNameFormatException;

/**
 * 
 * A qualified name identifying a parameter in a web route.
 * 
 * 
 * @author Jeremy Kuhn
 * @since 1.0
 */
public class WebParameterQualifiedName extends QualifiedName {

	private final WebRouteQualifiedName routeQName;
	
	private final String name;
	
	/**
	 * 
	 * Creates a web parameter qualified name with the specified route qualified name and parameter name.
	 * 
	 *
	 * @param routeQName the route qualified name
	 * @param name       the parameter name
	 *
	 * @throws QualifiedNameFormatException if the specified parameter name is invalid
	 */
	public WebParameterQualifiedName(WebRouteQualifiedName routeQName, String name) throws QualifiedNameFormatException {
		super(routeQName.getValue() + "." + name);
		
		this.routeQName = routeQName;
		this.name = name;
	}

	@Override
	public String getSimpleValue() {
		return this.getParameterName();
	}
	
	/**
	 * 
	 * Returns the route qualified name.
	 * 
	 * 
	 * @return the route qualified name
	 */
	public WebRouteQualifiedName getRouteQName() {
		return this.routeQName;
	}
	
	/**
	 * 
	 * Returns the parameter name.
	 * 
	 * 
	 * @return the parameter name
	 */
	public String getParameterName() {
		return this.name;
	}
	
	/**
	 * 
	 * Creates a web parameter qualified name from the specified raw value of the form {@code WebRouteQualifiedName():} where {@code } is a valid Java name.
	 * 
	 *
	 * @param qname a raw qualified name
	 *
	 * @return a web parameter qualified name
	 * @throws QualifiedNameFormatException if the specified value is not a web parameter qualified name
	 */
	public static WebParameterQualifiedName valueOf(String qname) throws QualifiedNameFormatException {
		int lastSeparatorIndex = qname.lastIndexOf(".");
		if (lastSeparatorIndex == -1) {
			throw new QualifiedNameFormatException("Invalid qname " + qname + ", was expecting: WebParameterQualifiedName().");
		}
		return new WebParameterQualifiedName(WebRouteQualifiedName.valueOf(qname.substring(0, lastSeparatorIndex)), qname.substring(lastSeparatorIndex + 1));
	}

	/**
	 * 
	 * Creates a web parameter qualified name from the specified bean qualified name of the web controller and the specified raw value of the form {@code :} where
	 * {@code } and {@code } are valid Java names.
	 * 
	 *
	 * @param controllerQName a web controller qualified name
	 * @param qname           a raw qualified name
	 *
	 * @return a web parameter qualified name
	 * @throws QualifiedNameFormatException if the specified value is not a web parameter qualified name
	 */
	public static WebParameterQualifiedName valueOf(BeanQualifiedName controllerQName, String qname)
			throws QualifiedNameFormatException {
		String[] qnameParts = qname.split(".");
		if (qnameParts.length < 2) {
			throw new QualifiedNameFormatException(
					"Invalid qname " + qname + ", was expecting: .");
		}
		return new WebParameterQualifiedName(new WebRouteQualifiedName(controllerQName, qnameParts[0]), qnameParts[1]);
	}
}