com.arangodb.shaded.vertx.uritemplate.UriTemplate Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2022 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package com.arangodb.shaded.vertx.uritemplate;
import com.arangodb.shaded.vertx.codegen.annotations.VertxGen;
import com.arangodb.shaded.vertx.uritemplate.impl.UriTemplateImpl;
/**
* A URI template that follows the rfc6570 level 4.
*
* A template is immutable and thread safe, it can be safely shared between threads after its creation.
* If you are sharing a template as a static variables, keep in mind that {@link #of(String)} can fail and create
* a classloading issue.
*
* @author Julien Viet
*/
@VertxGen
public interface UriTemplate {
/**
* Create a template from a string {@code uri}.
*
*
The string {@code uri} is validated and parsed, invalid inputs are rejected with a {@link IllegalArgumentException}.
*
* @param uri the template string
* @return the template
* @throws IllegalArgumentException when the template
*/
static UriTemplate of(String uri) {
return new UriTemplateImpl.Parser().parseURITemplate(uri);
}
/**
* Expand this template to a string.
*
* @param variables the variables
* @return the string expansion of this template with the {@code variables}
*/
String expandToString(Variables variables);
/**
* Expand this template to a string.
*
* @param variables the variables
* @param options the options to control template expansion
* @return the string expansion of this template with the {@code variables}
*/
String expandToString(Variables variables, ExpandOptions options);
}