ConnectorMessages.java

/*
 * ====================
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License("CDDL") (the "License").  You may not use this file
 * except in compliance with the License.
 *
 * You can obtain a copy of the License at
 * http://opensource.org/licenses/cddl1.php
 * See the License for the specific language governing permissions and limitations
 * under the License.
 *
 * When distributing the Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://opensource.org/licenses/cddl1.php.
 * If applicable, add the following below this CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * ====================
 */
package org.identityconnectors.framework.common.objects;

import org.identityconnectors.common.l10n.CurrentLocale;

/**
 * Message catalog for a given connector.
 *
 * @see CurrentLocale
 */
public interface ConnectorMessages {

    /**
     * Formats the given message key in the {@link CurrentLocale}.
     *
     * @param key
     *            The message key to format.
     * @param dflt
     *            The default message if key is not found. If null, defaults to
     *            key.
     * @param args
     *            Parameters with which to format the message.
     * @return The formatted string.
     */
    public String format(String key, String dflt, Object... args);
}