src/com/google/enterprise/adaptor/DocIdDecoder.java

// Copyright 2011 Google Inc. All Rights Reserved.
//
// 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.enterprise.adaptor;

import java.net.URI;

/**
 * Allows converting from a URI to a unvalidated DocId.
 *
 * @see DocIdEncoder
 */
interface DocIdDecoder {
  /**
   * Extract the DocId from the provided URI. Note that the DocId is not
   * guaranteed to have been created by the adaptor library; they can easily be
   * faked.
   */
  public DocId decodeDocId(URI uri);
}