<?xml version="1.0" encoding="Shift_JIS"?>
<!--
  Copyright 2003 The Apache Software Foundation.

  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.

  $Id: ParameterParser.xml,v 1.5 2005/03/30 01:31:05 shinobu Exp $
-->
<document>

    <properties>
        <title>ParameterParser</title>
        <author email="sidler@apache.org">Gabriel Sidler</author>
        <translator email="nekop@programmers.jp">木村 貴由</translator>
        <translator email="shinobu@ieee.org">Shinobu Kawai</translator>
        <projectfile>xdocs-ja/view/menu.xml</projectfile>
        <original>ParameterParser</original>
    </properties>

    <body>

    <section name="ParameterParser Reference Documentation" alias="ParameterParser リファレンスドキュメント">

        <primary>
        <p>View tool for easy parsing of ServletRequest parameters.</p>
        </primary>
        <p>ServletRequest のパラメータをパースするビューツールです。</p>
        <toolinfo>
            <version>@@@version@@@, @@@date@@@</version>

            <clazz>org.apache.velocity.tools.view.tools.ParameterParser</clazz>

            <name>$params</name>

            <author email="nathan@esha.com">Nathan Bubna</author>

            <config-example>&lt;tool&gt;
  &lt;key&gt;params&lt;/key&gt;
  &lt;scope&gt;request&lt;/scope&gt;
  &lt;class&gt;org.apache.velocity.tools.view.tools.ParameterParser&lt;/class&gt;
&lt;/tool&gt;</config-example>

        </toolinfo>

        <methods/>

    </section>

    <section name="exists()">
        <primary>
        <method name="exists()">

            <abstract>
                Returns <code>true</code> if a parameter for the specified key exists.
            </abstract>

            <signature>
                boolean exists(String key)
            </signature>

            <parameters>
                <parameter name="key">
                    The key of the parameter in question
                </parameter>
            </parameters>

            <returns>
              <code>true</code> if a parameter for the specified key exists or
              <code>false</code> if this parameter is not present or has no value.
            </returns>

        </method>
        </primary>
        <method name="exists()">

            <abstract>
                指定されたキーに対応するパラメータが存在する場合 <code>true</code> を返却します。
            </abstract>

            <signature>
                boolean exists(String key)
            </signature>

            <parameters>
                <parameter name="key">
                    問い合わせを行うパラメータのキー
                </parameter>
            </parameters>

            <returns>
              指定されたキーに対応するパラメータが存在する場合 <code>true</code> 、
              パラメータが存在しない、または値を持っていない場合 <code>false</code> 。
            </returns>

        </method>
    </section>

    <section name="getString()">
        <primary>
        <method name="getString()">

            <abstract>
                Returns the specified servlet request parameter as a String
            </abstract>

            <signature>
                String get(String key)
            </signature>

            <signature>
                String getString(String key)
            </signature>

            <signature>
                String getString(String key, String alternate)
            </signature>

            <parameters>
                <parameter name="key">
                    The key of the desired string parameter
                </parameter>

                <parameter name="alternate">
                    An alternate value
                </parameter>
            </parameters>

            <returns>
               The value of the parameter matching the specified key or the
               specified alternate String if there is no matching parameter.
               A value of <code>null</code> is returned if no alternate value
               is defined and the desired parameter is not found.
            </returns>

        </method>
        </primary>
        <method name="getString()">

            <abstract>
                指定されたサーブレットリクエストのパラメータを String 形式で返却します。
            </abstract>

            <signature>
                String get(String key)
            </signature>

            <signature>
                String getString(String key)
            </signature>

            <signature>
                String getString(String key, String alternate)
            </signature>

            <parameters>
                <parameter name="key">
                    要求するパラメータのキー
                </parameter>

                <parameter name="alternate">
                    代替値
                </parameter>
            </parameters>

            <returns>
               指定されたキーに一致するパラメータの値。
               一致するパラメータが無かった場合、指定された代替値が返却されます。
               代替値が指定されておらず、要求されたパラメータが見つからなかった場合には <code>null</code> が返却されます。
            </returns>

        </method>
    </section>



    <section name="getBoolean()">
        <primary>
        <method name="getBoolean()">

            <abstract>
                Returns the specified servlet request parameter as a Boolean object or
                a boolean primitive type
            </abstract>

            <signature>
                Boolean getBoolean(String key)
            </signature>

            <signature>
                Boolean getBoolean(String key, Boolean alternate)
            </signature>

            <signature>
                boolean getBoolean(String key, boolean alternate)
            </signature>

            <parameters>
                <parameter name="key">
                    The key of the desired string parameter
                </parameter>

                <parameter name="alternate">
                    An alternate value
                </parameter>
            </parameters>

            <returns>
               A Boolean object or boolean primitive type that represents the
               value of the servlet request parameter matching the specified key
               or the specified alternate boolean if there is no matching parameter.
               A value of <code>null</code> is returned if no alternate value
               is defined and the desired parameter is not found.
            </returns>

        </method>
        </primary>
        <method name="getBoolean()">

            <abstract>
                指定されたサーブレットリクエストのパラメータを Boolean オブジェクト、またはプリミティブの boolean 形式で返却します。
            </abstract>

            <signature>
                Boolean getBoolean(String key)
            </signature>

            <signature>
                Boolean getBoolean(String key, Boolean alternate)
            </signature>

            <signature>
                boolean getBoolean(String key, boolean alternate)
            </signature>

            <parameters>
                <parameter name="key">
                    要求するパラメータのキー
                </parameter>

                <parameter name="alternate">
                    代替値
                </parameter>
            </parameters>

            <returns>
               指定されたキーに一致するパラメータの値を表す Boolean オブジェクト、またはプリミティブの boolean を返却します。
               一致するパラメータが無かった場合、指定された代替値が返却されます。
               代替値が指定されておらず、要求されたパラメータが見つからなかった場合には <code>null</code> が返却されます。
            </returns>

        </method>
    </section>




    <section name="getNumber()">
        <primary>
        <method name="getNumber()">

            <abstract>
                Returns the specified servlet request parameter as a Number object
            </abstract>

            <signature>
                Number getNumber(String key)
            </signature>

            <signature>
                Number getNumber(String key, Number alternate)
            </signature>

            <parameters>
                <parameter name="key">
                    The key of the desired string parameter
                </parameter>

                <parameter name="alternate">
                    An alternate value
                </parameter>
            </parameters>

            <returns>
               A <code>java.lang.Number</code> object that represents the
               value of the servlet request parameter matching the specified key
               or the specified alternate Number if there is no matching parameter.
               A value of <code>null</code> is returned if no alternate value
               is defined and the desired parameter is not found.
            </returns>

        </method>
        </primary>
        <method name="getNumber()">

            <abstract>
                指定されたサーブレットリクエストのパラメータを Number オブジェクトとして返却します。
            </abstract>

            <signature>
                Number getNumber(String key)
            </signature>

            <signature>
                Number getNumber(String key, Number alternate)
            </signature>

            <parameters>
                <parameter name="key">
                    要求するパラメータのキー
                </parameter>

                <parameter name="alternate">
                    代替値
                </parameter>
            </parameters>

            <returns>
               指定されたキーに一致するパラメータの値を表す <code>java.lang.Number</code> オブジェクトを返却します。
               一致するパラメータが無かった場合、指定された代替値が返却されます。
               代替値が指定されておらず、要求されたパラメータが見つからなかった場合には <code>null</code> が返却されます。
            </returns>

        </method>
    </section>



    <section name="getInt()">
        <primary>
        <method name="getInt()">

            <abstract>
                Returns the specified servlet request parameter as an integer
            </abstract>

            <signature>
                int getInt(String key, int alternate)
            </signature>

            <parameters>
                <parameter name="key">
                    The key of the desired string parameter
                </parameter>

                <parameter name="alternate">
                    An alternate value
                </parameter>
            </parameters>

            <returns>
               An integer that represents the
               value of the servlet request parameter matching the specified key
               or the specified alternate value if there is no matching parameter.
            </returns>

        </method>
        </primary>
        <method name="getInt()">

            <abstract>
                指定されたサーブレットリクエストのパラメータを int として返却します。
            </abstract>

            <signature>
                int getInt(String key, int alternate)
            </signature>

            <parameters>
                <parameter name="key">
                    要求するパラメータのキー
                </parameter>

                <parameter name="alternate">
                    代替値
                </parameter>
            </parameters>

            <returns>
               指定されたキーに一致するパラメータの値を表す int を返却します。
               一致するパラメータが無かった場合、指定された代替値が返却されます。
            </returns>

        </method>
    </section>




    <section name="getDouble()">
        <primary>
        <method name="getDouble()">

            <abstract>
                Returns the specified servlet request parameter as a double
            </abstract>

            <signature>
                double getDouble(String key, double alternate)
            </signature>

            <parameters>
                <parameter name="key">
                    The key of the desired string parameter
                </parameter>

                <parameter name="alternate">
                    An alternate value
                </parameter>
            </parameters>

            <returns>
               An double that represents the
               value of the servlet request parameter matching the specified key
               or the specified alternate value if there is no matching parameter.
            </returns>

        </method>
        </primary>
        <method name="getDouble()">

            <abstract>
                指定されたサーブレットリクエストのパラメータを double として返却します。
            </abstract>

            <signature>
                double getDouble(String key, double alternate)
            </signature>

            <parameters>
                <parameter name="key">
                    要求するパラメータのキー
                </parameter>

                <parameter name="alternate">
                    代替値
                </parameter>
            </parameters>

            <returns>
               指定されたキーに一致するパラメータの値を表す double を返却します。
               一致するパラメータが無かった場合、指定された代替値が返却されます。
            </returns>

        </method>
    </section>



    <section name="getStrings()">
        <primary>
        <method name="getStrings()">

            <abstract>
                Returns an array of Strings of all the values of the specified servlet
                request parameter
            </abstract>

            <signature>
                String[] getStrings(String key)
            </signature>

            <parameters>
                <parameter name="key">
                    The key of the desired string parameter
                </parameter>

            </parameters>

            <returns>
               A array of Strings that represent all the values of the desired
               request parameter or <code>null</code> if the parameter does not
               exist.
            </returns>

        </method>
        </primary>
        <method name="getStrings()">

            <abstract>
                指定されたサーブレットリクエストの全てのパラメータを String の配列形式で返却します。
            </abstract>

            <signature>
                String[] getStrings(String key)
            </signature>

            <parameters>
                <parameter name="key">
                    要求するパラメータのキー
                </parameter>

            </parameters>

            <returns>
               指定されたキーに一致するパラメータの全ての値を表す String の配列。
               パラメータが無かった場合、 <code>null</code> が返却されます。
            </returns>

        </method>
    </section>




    <section name="getNumbers()">
        <primary>
        <method name="getNumbers()">

            <abstract>
                Returns an array of Numbers of all the values of the specified servlet
                request parameter
            </abstract>

            <signature>
                Number[] getNumbers(String key)
            </signature>

            <parameters>
                <parameter name="key">
                    The key of the desired string parameter
                </parameter>

            </parameters>

            <returns>
               A array of <code>java.lang.Number</code> that represent all the
               values of the desired request parameter or <code>null</code> if
               the parameter does not exist.
            </returns>

        </method>
        </primary>
        <method name="getNumbers()">

            <abstract>
                指定されたサーブレットリクエストの全てのパラメータを Number の配列形式で返却します。
            </abstract>

            <signature>
                Number[] getNumbers(String key)
            </signature>

            <parameters>
                <parameter name="key">
                    要求するパラメータのキー
                </parameter>

            </parameters>

            <returns>
               指定されたキーに一致するパラメータの全ての値を表す <code>java.lang.Number</code> の配列。
               パラメータが無かった場合、 <code>null</code> が返却されます。
            </returns>

        </method>
    </section>




    <section name="getInts()">
        <primary>
        <method name="getInts()">

            <abstract>
                Returns an array of integers of all the values of the specified servlet
                request parameter
            </abstract>

            <signature>
                int[] getInts(String key)
            </signature>

            <parameters>
                <parameter name="key">
                    The key of the desired string parameter
                </parameter>

            </parameters>

            <returns>
               A array of integer primitive types that represent all the
               values of the desired request parameter or <code>null</code> if
               the parameter does not exist.
            </returns>

        </method>
        </primary>
        <method name="getInts()">

            <abstract>
                指定されたサーブレットリクエストの全てのパラメータを int の配列形式で返却します。
            </abstract>

            <signature>
                int[] getInts(String key)
            </signature>

            <parameters>
                <parameter name="key">
                    要求するパラメータのキー
                </parameter>

            </parameters>

            <returns>
               指定されたキーに一致するパラメータの全ての値を表す int の配列。
               パラメータが無かった場合、 <code>null</code> が返却されます。
            </returns>

        </method>
    </section>




    <section name="getDoubles()">
        <primary>
        <method name="getDoubles()">

            <abstract>
                Returns an array of doubles of all the values of the specified servlet
                request parameter
            </abstract>

            <signature>
                double[] getDoubles(String key)
            </signature>

            <parameters>
                <parameter name="key">
                    The key of the desired string parameter
                </parameter>

            </parameters>

            <returns>
               A array of double primitive types that represent all the
               values of the desired request parameter or <code>null</code> if
               the parameter does not exist.
            </returns>

        </method>
        </primary>
        <method name="getDoubles()">

            <abstract>
                指定されたサーブレットリクエストの全てのパラメータを double の配列形式で返却します。
            </abstract>

            <signature>
                double[] getDoubles(String key)
            </signature>

            <parameters>
                <parameter name="key">
                    要求するパラメータのキー
                </parameter>

            </parameters>

            <returns>
               指定されたキーに一致するパラメータの全ての値を表す double の配列。
               パラメータが無かった場合、 <code>null</code> が返却されます。
            </returns>

        </method>
    </section>


 </body>
</document>

