org.jboss.weld.logging.MessageCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of weld-servlet-shaded Show documentation

This jar bundles all the bits of Weld and CDI required for running in a Servlet container.

There is a newer version: 6.0.0.Beta4

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2014, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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 org.jboss.weld.logging;

import org.jboss.logging.annotations.Message;

/**
 * JBoss Logging is not using message keys and so it's not possible to reference the message (a message method annotated with {@link Message}) and use it as a
 * method parameter or construct it lazily. This callback should be used to work around this limitation.
 *
 * Note that the method parameters are not checked and so the invocation may result in {@link ArrayIndexOutOfBoundsException}.
 *
 * @author Martin Kouba
 * @param  The type of the return value (either {@link String} or {@link Throwable})
 * @see Message
 */
@FunctionalInterface
public interface MessageCallback {

    /**
     * Constructs the message or Throwable.
     *
     * @param params
     * @return the return value
     */
    T construct(Object... params);

}