001/*
002 * Copyright 2002-2020 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.util;
018
019/**
020 * Factory to create {@link UriBuilder} instances with shared configuration
021 * such as a base URI, an encoding mode strategy, and others across all URI
022 * builder instances created through a factory.
023 *
024 * @author Rossen Stoyanchev
025 * @since 5.0
026 * @see DefaultUriBuilderFactory
027 */
028public interface UriBuilderFactory extends UriTemplateHandler {
029
030        /**
031         * Initialize a builder with the given URI template.
032         * @param uriTemplate the URI template to use
033         * @return the builder instance
034         */
035        UriBuilder uriString(String uriTemplate);
036
037        /**
038         * Create a URI builder with default settings.
039         * @return the builder instance
040         */
041        UriBuilder builder();
042
043}