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.scxml;
    18
    19  /***
    20   * Interface for a component that may be used by the SCXML engines
    21   * to resolve context sensitive paths.
    22   *
    23   */
    24  public interface PathResolver {
    25
    26      /***
    27       * Resolve this context sensitive path to an absolute URL.
    28       *
    29       * @param ctxPath Context sensitive path, can be a relative URL
    30       * @return Resolved path (an absolute URL) or <code>null</code>
    31       */
    32      String resolvePath(String ctxPath);
    33
    34      /***
    35       * Get a PathResolver rooted at this context sensitive path.
    36       *
    37       * @param ctxPath Context sensitive path, can be a relative URL
    38       * @return Returns a new resolver rooted at ctxPath
    39       */
    40      PathResolver getResolver(String ctxPath);
    41
    42  }
    43