LocalizableMessage.java

/* Copyright 2005-2006 Tim Fennell
 *
 * 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.sourceforge.stripes.action;

import net.sourceforge.stripes.controller.StripesFilter;

import java.util.Locale;
import java.util.ResourceBundle;

/**
 * A non-error message class that can localize (or at least externalize) the message String
 * in a resource bundle.  The bundle used is the Stripes error message bundle, which can be
 * configured but by default is called 'StripesResources.properties'.  In all other ways
 * this class behaves like its parent {@link SimpleMessage}.
 *
 * @author Tim Fennell 
 */
public class LocalizableMessage extends SimpleMessage {
	private static final long serialVersionUID = 1L;

    private String messageKey;

    /**
     * Creates a new LocalizableMessage with the message key provided, and optionally zero or more
     * replacement parameters to use in the message.
     *
     * @param messageKey a key to lookup a message in the resource bundle
     * @param parameter one or more replacement parameters to insert into the message
     */
    public LocalizableMessage(String messageKey, Object... parameter) {
        super((String) null, parameter);
        this.messageKey = messageKey;
    }

    /**
     * Method responsible for using the information supplied to the message object to find a
     * message template. In this class this is done simply by looking up the resource
     * corresponding to the messageKey supplied in the constructor.
     */
    @Override
    protected String getMessageTemplate(Locale locale) {
        ResourceBundle bundle = StripesFilter.getConfiguration().
                getLocalizationBundleFactory().getErrorMessageBundle(locale);

        return bundle.getString(messageKey);
    }

    /**
     * Generated equals method which will return true if the other object is of the same
     * type as this instance, and would produce the same user message.
     *
     * @param o an instance of LocalizableMessage or subclass thereof
     * @return true if the two messages would produce the same user message, false otherwise
     */
    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        if (!super.equals(o)) {
            return false;
        }

        final LocalizableMessage that = (LocalizableMessage) o;

        if (messageKey != null ? !messageKey.equals(that.messageKey) : that.messageKey != null) {
            return false;
        }

        return true;
    }

    /** Generated hashCode method. */
    @Override
    public int hashCode() {
        int result = super.hashCode();
        result = 29 * result + (messageKey != null ? messageKey.hashCode() : 0);
        return result;
    }

    public String getMessageKey() {
        return messageKey;
    }
}