org.apache.myfaces.view.facelets.pool.impl.MetadataViewKey Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.myfaces.view.facelets.pool.impl;

import java.util.Locale;

/**
 * A MetadataViewKey contains the necessary information that identifies a view
 * according to its specific attributes that makes its structure different.
 * A view with the same MetadataViewKey can be reused if and only if its metadata
 * is the same.
 * 
 * Classes implementing this class should implements equals() and hashCode() 
 * methods too.
 */
public abstract class MetadataViewKey
{
    public abstract String getViewId();

    public abstract String getRenderKitId();

    public abstract Locale getLocale();

    public abstract String[] getContracts();

}