AvailabilityLocaleCacheKey.java

/*
 * Copyright (C) 2012 Tirasa
 *
 * Licensed 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 net.tirasa.hct.cocoon.cache;

import java.util.Locale;
import net.tirasa.hct.cocoon.sax.Constants.Availability;
import org.apache.cocoon.pipeline.caching.AbstractCacheKey;
import org.apache.cocoon.pipeline.caching.CacheKey;
import org.apache.cocoon.pipeline.util.StringRepresentation;
import org.apache.cocoon.util.murmurhash.MurmurHashCodeBuilder;

public class AvailabilityLocaleCacheKey extends AbstractCacheKey {

    private static final long serialVersionUID = -2826221049544275274L;

    private final Availability availability;

    private final Locale locale;

    public AvailabilityLocaleCacheKey(final Availability availability, final Locale locale) {
        this.availability = availability;
        this.locale = locale;
    }

    public Availability getAvailability() {
        return availability;
    }

    public Locale getLocale() {
        return locale;
    }

    /**
     * Never expires.
     *
     * @return 0 - never expires
     */
    @Override
    public long getLastModified() {
        return 0;
    }

    @Override
    public boolean isValid(final CacheKey cacheKey) {
        return this.equals(cacheKey);
    }

    @Override
    public boolean equals(final Object obj) {
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final AvailabilityLocaleCacheKey other = (AvailabilityLocaleCacheKey) obj;
        if (this.availability != other.availability || !this.locale.equals(other.locale)) {
            return false;
        }
        return true;
    }

    @Override
    public int hashCode() {
        return new MurmurHashCodeBuilder().append(this.getClass().getName()).
                append(this.availability.name()).append(this.locale.toString()).toHashCode();
    }

    @Override
    public String toString() {
        return StringRepresentation.buildString(this, "availability=" + this.availability, "locale=" + this.locale);
    }
}