io.csar.Concern Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2009 GlobalMentor, Inc. 
 *
 * 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
 *
 *     https://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 io.csar;

/**
 * Represents a concern (usually a
 * cross-cutting concern) of a program such as logging or internationalization.
 * 
 * This framework allows concerns to be specified locally via a {@link DecoratedConcernedThreadGroup}, or as a global default using
 * {@link Csar#registerDefaultConcern(Concern)}.
 * 
 * 
 * Each type of concern should override {@link #getConcernType()} to return the class (normally an interface) representing a type of concern such as logging or
 * i18n.
 * 
 * @author Garret Wilson
 * @see Csar
 */
public interface Concern {

	/**
	 * Returns the type or classification of concern. By default this is the class with which a concern will be registered in a {@link ConcernRegistry}.
	 * 
	 * The default implementation returns the class of the current instance.
	 * 
	 * @return The class representing the type of concern.
	 * @see ConcernRegistry#registerConcern(Concern)
	 */
	public default Class getConcernType() {
		return getClass();
	}

}