net.sf.qualitycheck.ArgumentsChecked Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quality-check Show documentation

The goal of quality-check is to provide a small Java library for basic runtime code quality checks. It provides similar features to org.springframework.util.Assert or com.google.common.base.Preconditions without the need to include big libraries or frameworks such as Spring or Guava. The package quality-check tries to replace these libraries and provide all the basic code quality checks you need. The checks provided here are typically used to validate method parameters and detect errors during runtime. To detect errors before runtime we use JSR-305 Annotations. With these annotations you are able to detect possible bugs earlier. For more informations look at FindBugs™ JSR-305 support.

There is a newer version: 1.3

Show newest version

/*******************************************************************************
 * Copyright 2013 André Rouél and Dominik Seichter
 * 
 * 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.sf.qualitycheck;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Indicates that a method is intended to check all its arguments using Quality-Check. If a method is annotated
 * with this annotation the method is responsible to check all arguments against basic conditions like not null, not
 * empty etc.
 * 
 * 
 * In turn the caller has to be aware that exceptions like {@code IllegalNullArgumentException} will be thrown by the
 * method if input arguments are not valid.
 * 
 * 

 * The following example describes how to use it.
 * 
 * 
 * @ArgumentsChecked
 * public void validate(Object o) {
 * 	Check.notNull(o);
 * }
 * 
 * 
 * 
 * Additionally it can be documented which exceptions may occur if given arguments are invalid using
 * the additional annotation {@code @Throws}.
 * 
 * 
 * @ArgumentsChecked
 * @Throws(IllegalNullArgumentException.class)
 * public void validate(Object o) {
 * 	Check.notNull(o);
 * }
 * 
 * 
 * @author André Rouél
 * @author Dominik Seichter
 */
@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = { ElementType.CONSTRUCTOR, ElementType.METHOD })
public @interface ArgumentsChecked {

}