1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.myfaces.view;
20
21 import javax.faces.view.ViewDeclarationLanguage;
22
23 /**
24 * This class represents a supported {@link ViewDeclarationLanguage} in the application. Notably,
25 * the default ViewDeclarationLanguageFactory maintains an ordered list of supported languages for
26 * the purpose of determining which one to use for a given view id by calling the {@link #handles}
27 * method of each ofthe registered support and using the first match.
28 *
29 * @author Simon Lessard (latest modification by $Author$)
30 * @version $Revision$ $Date$
31 *
32 * @since 2.0
33 */
34 public interface ViewDeclarationLanguageStrategy
35 {
36 /**
37 * Gets the {@link ViewDeclarationLanguage} represented by this support.
38 *
39 * @return the {@link ViewDeclarationLanguage} represented by this support
40 */
41 public ViewDeclarationLanguage getViewDeclarationLanguage();
42
43 /**
44 * Determines if the {@link ViewDeclarationLanguage} represented by this support should be used
45 * to handle the specified view identifier.
46 *
47 * @param viewId the view identifier
48 *
49 * @return <code>true</code> if the {@link ViewDeclarationLanguage} represented by this support
50 * should be used to handle the specified view identifier, <code>false</code> otherwise
51 */
52 public boolean handles(String viewId);
53
54 /**
55 * Return a string that can be used as a outcome for the viewId, usually removing the extension.
56 *
57 * @since 2.3
58 * @param viewId
59 * @return
60 */
61 public String getMinimalImplicitOutcome(String viewId);
62 }