View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.transaction.file;
18  
19  /**
20   * Maps transaction ids to paths and back.
21   * 
22   * @version $Id: TransactionIdToPathMapper.java 493632 2007-01-07 01:57:31Z joerg $
23   * @since 1.2
24   */
25  public interface TransactionIdToPathMapper {
26  
27      /**
28       * Maps the transaction id object to a path string. 
29       * 
30       * @param txId the transaction id
31       * @return the path string
32       */
33      String getPathForId(Object txId);
34      
35      /**
36       * Maps the path string to a transaction id object. 
37       * 
38       * @param path the path
39       * @return the path string
40       */
41      Object getIdForPath(String path);
42      
43  }