001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.request.mapper.parameter;
018
019import org.apache.wicket.util.string.StringValue;
020
021
022/**
023 * Container for parameters that are identified by their index
024 * 
025 * @author igor
026 */
027public interface IIndexedParameters
028{
029        /**
030         * Sets the indexed parameter on given index
031         * 
032         * @param index
033         *          The position of the parameter
034         * @param object
035         *          The parameter at this position
036         * @return this instance, for chaining
037         */
038        IIndexedParameters set(final int index, final Object object);
039
040        /**
041         * @param index
042         *          The position of the parameter
043         * @return indexed parameter on given index
044         */
045        StringValue get(final int index);
046
047        /**
048         * Removes indexed parameter on given index
049         * 
050         * @param index
051         *          The position of the parameter
052         * @return this instance, for chaining
053         */
054        IIndexedParameters remove(final int index);
055
056        /**
057         * Removes all indexed parameters.
058         * 
059         * @return this instance, for chaining
060         */
061        IIndexedParameters clearIndexed();
062}