View Javadoc

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.facelets.pool.impl;
20  
21  import java.util.Locale;
22  
23  /**
24   * A MetadataViewKey contains the necessary information that identifies a view
25   * according to its specific attributes that makes its structure different.
26   * A view with the same MetadataViewKey can be reused if and only if its metadata
27   * is the same.
28   * 
29   * Classes implementing this class should implements equals() and hashCode() 
30   * methods too.
31   */
32  public abstract class MetadataViewKey
33  {
34      public abstract String getViewId();
35  
36      public abstract String getRenderKitId();
37  
38      public abstract Locale getLocale();
39  
40      public abstract String[] getContracts();
41  
42  }