patterntesting.runtime.annotation.UnsupportedOperation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of patterntesting-rt Show documentation

PatternTesting Runtime (patterntesting-rt) is the runtime component for the PatternTesting framework. It provides the annotations and base classes for the PatternTesting testing framework (e.g. patterntesting-check, patterntesting-concurrent or patterntesting-exception) but can be also used standalone for classpath monitoring or profiling. It uses AOP and AspectJ to perform this feat.

There is a newer version: 2.4.0

Show newest version

/**
 * $Id: UnsupportedOperation.java,v 1.2 2010/06/08 21:32:53 oboehm Exp $
 *
 * Copyright (c) 2008 by Oliver Boehm
 *
 * 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 orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 19.10.2008 by oliver ([email protected])
 */
package patterntesting.runtime.annotation;

import java.lang.annotation.*;

/**
 * This is similar to the @NotYetImplemented annotation. The difference is
 * only the semantic:
 * "@UnsupportedOperation" means, it is not supported yet and the annotated
 * method will probably also not supported in the future.
 * "@NotYetImplemented" means, that the method is not yet implemented but will
 * be available in the (near) future.
 *
 * @see NotYetImplemented
 * @{link "patterntesting.sample.Fraction how to use it"}
 * @see java.text.MessageFormat
 * @author oliver
 * @since 19.10.2008
 * @version $Revision: 1.2 $
 */
@Documented
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface UnsupportedOperation {

    /**
     * You can define the text here which is used for the thrown
     * UnsupportedOperationException. You can add "{0}" if you want to see
     * the method name in the exception e.g.
     * @NotYetImplemented("don''t call {0} today").
     */
    String value() default "{0} is not supported";
}