org.teamapps.ux.session.navigation.annotation.QueryParameter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of teamapps-ux Show documentation

TeamApps UX

There is a newer version: 0.9.194

/*-
 * ========================LICENSE_START=================================
 * TeamApps
 * ---
 * Copyright (C) 2014 - 2024 TeamApps.org
 * ---
 * 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.
 * =========================LICENSE_END==================================
 */
package org.teamapps.ux.session.navigation.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface QueryParameter {

	/**
	 * Defines the name of the HTTP query parameter whose value will be used to initialize the value of the annotated method
	 * argument. The name is specified in decoded form, any percent encoded literals within
	 * the value will not be decoded and will instead be treated as literal text. E.g. if the parameter name is "a b" then
	 * the value of the annotation is "a b", not "a+b" or "a%20b".
	 */
	String value();

}