io.springlets.web.mvc.util.MethodLinkBuilder Maven / Gradle / Ivy
/*
* Copyright 2016 the original author or authors.
*
* 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.springlets.web.mvc.util;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.util.UriComponents;
/**
* Build links to controller methods. Provides a simple DSL to set the method
* parameters as well as the path variables needed to build the URI to the
* controller method.
* @param the class of the Controller to create links to
* @author Cèsar Ordiñana at http://www.disid.com[DISID Corporation S.L.]
*/
public interface MethodLinkBuilder {
/**
* Provides parameters for the method. It will add the given parameters
* to any previously added ones.
* @param parameters of the method
* @return the builder with the given method parameters
*/
MethodLinkBuilder arg(int index, Object parameter);
/**
* Adds a path variable to build the method URI. The variable name must be
* the same as the one included between {} clauses in the
* {@link RequestMapping} of the method.
* @param variable name of the path variable
* @param value value to replace with
* @return the builder with the given path variable
*/
MethodLinkBuilder with(String variable, Object value);
/**
* Creates a {@link UriComponents} instance with the current builder
* configuration.
* @return the uri to the method with the current configuration
*/
UriComponents toUri();
/**
* Returns the full URI String to the method with the current builder
* configuration.
* @return the full URI String
*/
String toUriString();
/**
* Returns the Path of the URI String to the method with the current builder
* configuration.
* @return the URI path
*/
String toPath();
}