概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.seasar.cubby.routing
インタフェース PathResolver

既知の実装クラスの一覧:
  PathResolverImpl

    public interface PathResolver

パスに対応するアクションメソッドを解決するためのクラスです。

作成者:
  baba

メソッドの概要
`void` | `add(Class<?> actionClass)` 指定されたアクションクラスのルーティング情報を登録します。
`void` | `add(String actionPath, Class<?> actionClass, String actionMethodName, RequestMethod requestMethod, String onSubmit, int priority)` ルーティング情報を手動登録します。
`void` | `addAll(Collection<Class<?>> actionClasses)` 指定されたアクションクラスのコレクションからすべてのルーティング情報を登録します。
`void` | `clear()` 登録されたルーティング情報をクリアします。
`PathInfo` | `getPathInfo(String path, String requestMethod, String characterEncoding)` 指定されたパスとメソッドからフォワードするための情報を抽出します。
`Collection<Routing>` | `getRoutings()` ルーティング情報の一覧を取得します。
`String` | `reverseLookup(Class<?> actionClass, String methodName, Map<String,String[]> parameters, String characterEncoding)` 指定されたアクションクラス、メソッド名、パラメータからパスを逆引きします。

メソッドの詳細

### getPathInfo

    PathInfo getPathInfo(String path,
                         String requestMethod,
                         String characterEncoding)

  指定されたパスとメソッドからフォワードするための情報を抽出します。

  パスにマッチするパターンがない場合は `null` を返します。

  パラメータ:
    `path` - パス
    `requestMethod` - HTTPメソッド
    `characterEncoding` - URI のエンコーディング
  戻り値:
    フォワード情報

### getRoutings

    Collection<Routing> getRoutings()

  ルーティング情報の一覧を取得します。 ルーティング情報は優先度順にソートされています。

  戻り値:
    ルーティング情報の一覧

### add

    void add(Class<?> actionClass)

  指定されたアクションクラスのルーティング情報を登録します。

  パラメータ:
    `actionClass` - アクションクラス
  例外:
    `RoutingException` - ルーティング情報の登録に失敗した場合

### addAll

    void addAll(Collection<Class<?>> actionClasses)

  指定されたアクションクラスのコレクションからすべてのルーティング情報を登録します。

  パラメータ:
    `actionClasses` - アクションクラスのコレクション
  例外:
    `RoutingException` - ルーティング情報の登録に失敗した場合

### add

    void add(String actionPath,
             Class<?> actionClass,
             String actionMethodName,
             RequestMethod requestMethod,
             String onSubmit,
             int priority)

  ルーティング情報を手動登録します。

  パラメータ:
    `actionPath` - アクションのパス
    `actionClass` - アクションクラス
    `actionMethodName` - アクションメソッド名
    `requestMethod` - 要求メソッド
    `onSubmit` - アクションメソッドへ振り分けるための要求パラメータ名
    `priority` - プライオリティ
  例外:
    `RoutingException` - ルーティング情報の登録に失敗した場合

### clear

    void clear()

  登録されたルーティング情報をクリアします。

### reverseLookup

    String reverseLookup(Class<?> actionClass,
                         String methodName,
                         Map<String,String[]> parameters,
                         String characterEncoding)

  指定されたアクションクラス、メソッド名、パラメータからパスを逆引きします。

  パラメータ:
    `actionClass` - アクションクラス
    `methodName` - メソッド名
    `parameters` - パラメータ
    `characterEncoding` - URI のエンコーディング
  戻り値:
    リダイレクト用のパス
  例外:
    `RoutingException` - ルーティング情報の逆引きに失敗した場合

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Copyright © 2006-2009 The Seasar Foundation. All Rights Reserved.