src/adaptorlib/DocIdEncoder.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 adaptorlib;

import java.net.URI;

/**
 * Allows generating a URI for a particular DocId.
 *
 * @see DocIdDecoder
 */
public interface DocIdEncoder {
  /**
   * Encode the provided DocId into a URI.
   */
  public URI encodeDocId(DocId docId);
}