/*
* $Header: /home/cvs/struts/xdocs/struts1.1/documentation/ja/src/share/org/apache/struts/action/ActionForward.java,v 1.4 2003/12/16 16:46:16 skirnir Exp $
* $Revision: 1.4 $
* $Date: 2003/12/16 16:46:16 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Struts", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* .
*
*/
package org.apache.struts.action;
import org.apache.struts.config.ForwardConfig;
/**
* ActionForwardはActionクラスの処理の結果、
* コントローラServlet(ActionServlet)によって実行される、
* RequestDispatcher.forward()またはHttpServletResponse.sendRedirect()の遷移先を表わします。
* このクラスのインスタンスは必要に応じて動的に生成される場合と、
* あるマッピングインスタンスに対して複数存在しうる遷移先の中から名前による検索を行うために、
* ActionMappingの中に設定されている場合があります。
* {@primary An ActionForward represents a destination to which the
* controller servlet, ActionServlet, might be directed to
* perform a RequestDispatcher.forward() or
* HttpServletResponse.sendRedirect() to, as a result of
* processing activities of an Action class. Instances of this
* class may be created dynamically as necessary, or configured in association
* with an ActionMapping instance for named lookup of potentially
* multiple destinations for a particular mapping instance.}
*
* ActionForwardは少なくとも以下のプロパティを持ちます。
* 追加プロパティは必要に応じてサブクラスによって提供されます。
* {@primary
* An ActionForward has the following minimal set of properties.
* Additional properties can be provided as needed by subclassses.}
*
* - contextRelative -
pathの値が
* '/'文字で始まっている場合にpath
* の値を（モジュール相対の代わりに）
* コンテキスト相対で解釈するべきかどうかです。[false]
* - name - 特定の
ActionMappingとの関係の中からこのインスタンスを探し出すときに用いる論理名です。
* - path - 制御がフォワードされるべきモジュール相対もしくはコンテキスト相対URI、または、リダイレクトされるべき相対または絶対URIです。
*
- redirect - もしコントローラサーブレットがその関連付けられているパスに制御を移す際に
HttpServletResponse.sendRedirect()を呼び出すならtrue、
* そうでなければfalseです。[false]
*
* {@primary
* - contextRelative - Should the
path
* value be interpreted as context-relative (instead of
* module-relative, if it starts with a '/' character? [false]
* - name - Logical name by which this instance may be
* looked up in relationship to a particular
ActionMapping.
*
* - path - Module-relative or context-relative URI to
* which control should be forwarded, or an absolute or relative URI to
* which control should be redirected.
* - redirect - Set to
true if the controller
* servlet should call HttpServletResponse.sendRedirect()
* on the associated path; otherwise false. [false]
*
}
*
* Struts1.1からはこのクラスはForwardConfig
* を拡張してcontextRelativeプロパティを継承しています。
* {@primary
Since Struts 1.1 this class extends ForwardConfig
* and inherits the contextRelative property.}
*
*
注意 - このクラスが既存のアプリケーションが使用している公開されたAPIの一部であるという事実がなければ、
* このクラスの使用は推奨されずに
* org.apache.struts.config.ForwardConfig
* に置き換えられていたでしょう。
* {@primary NOTE - This class would have been deprecated and
* replaced by org.apache.struts.config.ForwardConfig except
* for the fact that it is part of the public API that existing applications
* are using.
}
*
* @author Craig R. McClanahan
* @version $Revision: 1.4 $ $Date: 2003/12/16 16:46:16 $
* @translator おかだひでひさ
* @translator 横田 健彦
* @status firstdraft
* @update 2003/12/15
* @memo ブロックA
*/
public class ActionForward extends ForwardConfig {
/**
* デフォルトの値を用いて新しいインスタンスを構築します。
* {@primary Construct a new instance with default values.]
*/
public ActionForward() {
this(null, false);
}
/**
* 指定されたパスを用いて新しいインスタンスを構築します。
* {@primary Construct a new instance with the specified path.}
*
* @param path このインスタンスに設定するパス
* {@primary Path for this instance}
*/
public ActionForward(String path) {
this(path, false);
}
/**
* 指定されたパスとりダイレクトフラグを用いて新しいインスタンスを構築します。
* {@primary Construct a new instance with the specified path and redirect flag.}
*
* @param path このインスタンスに設定するパス
* {@primary Path for this instance}
* @param redirect このインスタンスに設定するリダイレクトフラグ
* {@primary Redirect flag for this instance}
*/
public ActionForward(String path, boolean redirect) {
super();
setName(null);
setPath(path);
setRedirect(redirect);
}
/**
* 指定されたパスとりダイレクトフラグを用いて新しいインスタンスを構築します。
* {@primary Construct a new instance with the specified path and redirect flag.
*
* @param name このインスタンスの名前
* {@primary Name of this instance}
* @param path このインスタンスに設定するパス
* {@primary Path for this instance}
* @param redirect このインスタンスに設定するリダイレクトフラグ
* {@primary Redirect flag for this instance}
*/
public ActionForward(String name, String path, boolean redirect) {
super();
setName(name);
setPath(path);
setRedirect(redirect);
}
/**
* 指定された値を用いて新しいインスタンスを構築します。
* {@primary Construct a new instance with the specified values.}
*
* @param name このインスタンスの名前
* {@primary Name of this instance}
* @param path このインスタンスに設定するパス
* {@primary Path for this instance}
* @param redirect このインスタンスに設定するリダイレクトフラグ
* {@primary Redirect flag for this instance}
* @param contextRelative このインスタンスに設定するコンテキスト相対フラグ
* {@primary Context relative flag for this instance}
*/
public ActionForward(String name, String path, boolean redirect,
boolean contextRelative) {
super();
setName(name);
setPath(path);
setRedirect(redirect);
setContextRelative(contextRelative);
}
}