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.util.string;
018
019/**
020 * Typesafe interface to an ordered sequence of strings. An IStringIterator can be retrieved for the
021 * sequence by calling iterator(), the number of Strings in the sequence can be determined by
022 * calling size() and a given String can be retrieved by calling get(int index).
023 * 
024 * @author Jonathan Locke
025 */
026public interface IStringSequence
027{
028        /**
029         * Gets a string at a given index in the sequence
030         * 
031         * @param index
032         *            The index
033         * @return The string at the given index
034         * @throws IndexOutOfBoundsException
035         */
036        String get(int index) throws IndexOutOfBoundsException;
037
038        /**
039         * @return Typesafe string iterator
040         */
041        IStringIterator iterator();
042
043        /**
044         * @return Number of strings in this sequence
045         */
046        int size();
047}