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.core.util.resource.locator;
018
019import java.util.Iterator;
020import java.util.Locale;
021
022/**
023 * Contains the logic to locate a resource based on a path, style (see
024 * {@link org.apache.wicket.Session}), variation, locale and extension strings.
025 * 
026 * @author Juergen Donnerstag
027 */
028public interface IResourceNameIterator extends Iterator<String>
029{
030        /**
031         * Get the exact Locale which has been used for the latest resource path.
032         * 
033         * @return current Locale
034         */
035        Locale getLocale();
036
037        /**
038         * Get the exact Style which has been used for the latest resource path.
039         * 
040         * @return current Style
041         */
042        String getStyle();
043
044        /**
045         * Get the exact Variation which has been used for the latest resource path.
046         * 
047         * @return current Variation
048         */
049        String getVariation();
050
051        /**
052         * Get the exact filename extension used for the latest resource path.
053         * 
054         * @return current filename extension
055         */
056        String getExtension();
057}