home | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Java example source code file (UriPatternMatcher.java)

This example Java source code file (UriPatternMatcher.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

string, uripatternmatcher, uripatterntype

The UriPatternMatcher.java Java example source code

/**
 * Copyright (C) 2008 Google Inc.
 *
 * 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 com.google.inject.servlet;

/**
 * A general interface for matching a URI against a URI pattern. Guice-servlet provides regex and
 * servlet-style pattern matching out of the box.
 *
 * @author dhanji@gmail.com (Dhanji R. Prasanna)
 */
interface UriPatternMatcher {
  /**
   * @param uri A "contextual" (i.e. relative) and "normalized" Request URI, *not* a complete one.
   * @return Returns true if the uri matches the pattern.
   */
  boolean matches(String uri);

  /**
   * @param pattern The Path that this service pattern can match against.
   * @return Returns a canonical servlet path from this pattern. For instance, if the pattern is
   *         {@code /home/*} then the path extracted will be {@code /home}. Each pattern matcher
   *         implementation must decide and publish what a canonical path represents.
   *
   *         NOTE(dhanji): This method returns null for the regex pattern matcher.
   */
  String extractPath(String pattern);
  
  /** Returns the type of pattern this is. */
  UriPatternType getPatternType();

  /** Returns the original pattern that was registered. */
  String getOriginalPattern();
}

Other Java examples (source code examples)

Here is a short list of links related to this Java UriPatternMatcher.java source code file:



my book on functional programming

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.