| /* |
| * The contents of this file are subject to the terms |
| * of the Common Development and Distribution License |
| * (the "License"). You may not use this file except |
| * in compliance with the License. |
| * |
| * You can obtain a copy of the license at |
| * http://www.opensource.org/licenses/cddl1.php |
| * See the License for the specific language governing |
| * permissions and limitations under the License. |
| */ |
| |
| /* |
| * PathSegment.java |
| * |
| * Created on January 30, 2007, 4:35 PM |
| * |
| */ |
| |
| package javax.ws.rs.core; |
| |
| /** |
| * Represents a URI path segment and any associated matrix parameters. When an |
| * instance of this type is injected with {@link javax.ws.rs.PathParam}, the |
| * value of the annotation identifies which path segment is selected and the |
| * presence of an {@link javax.ws.rs.Encoded} annotation will result in an |
| * instance that supplies the path and matrix parameter values in |
| * URI encoded form. |
| * |
| * @see UriInfo#getPathSegments |
| * @see javax.ws.rs.PathParam |
| */ |
| public interface PathSegment { |
| |
| /** |
| * Get the path segment. |
| * <p> |
| * @return the path segment |
| */ |
| String getPath(); |
| |
| /** |
| * Get a map of the matrix parameters associated with the path segment. |
| * The map keys are the names of the matrix parameters with any |
| * percent-escaped octets decoded. |
| * |
| * @return the map of matrix parameters |
| * @see <a href="http://www.w3.org/DesignIssues/MatrixURIs.html">Matrix URIs</a> |
| */ |
| MultivaluedMap<String, String> getMatrixParameters(); |
| |
| } |