Re-implement to avoid previous license.

Rewrite all Javadocs to be much simpler but we are open to more text.
This commit is contained in:
Gary Gregory 2016-11-28 13:27:25 -08:00
parent def3c4672b
commit 2cd3f0f10a
5 changed files with 10 additions and 104 deletions

View File

@ -6,8 +6,3 @@ The Apache Software Foundation (http://www.apache.org/).
This product includes software from the Spring Framework,
under the Apache License 2.0 (see: StringUtils.containsWhitespace())
This product includes software Copyright (c) 2005 Brian Goetz and Tim Peierls
Released under the Creative Commons Attribution License (http://creativecommons.org/licenses/by/2.5)
Official home: http://www.jcip.net
Any republication or derived work distributed in source code form must include this copyright and license notice.

View File

@ -16,63 +16,24 @@
*/
package org.apache.commons.lang3.concurrent.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/*
* Copyright (c) 2005 Brian Goetz
* Released under the Creative Commons Attribution License
* (http://creativecommons.org/licenses/by/2.5)
* Official home: http://www.jcip.net
*
* Any republication or derived work distributed in source code form
* must include this copyright and license notice.
*/
/**
* GuardedBy
*
* The field or method to which this annotation is applied can only be accessed
* when holding a particular lock, which may be a built-in (synchronization)
* lock, or may be an explicit java.util.concurrent.Lock.
*
* The argument determines which lock guards the annotated field or method: this
* : The string literal "this" means that this field is guarded by the class in
* which it is defined. class-name.this : For inner classes, it may be necessary
* to disambiguate 'this'; the class-name.this designation allows you to specify
* which 'this' reference is intended itself : For reference fields only; the
* object to which the field refers. field-name : The lock object is referenced
* by the (instance or static) field specified by field-name.
* class-name.field-name : The lock object is reference by the static field
* specified by class-name.field-name. method-name() : The lock object is
* returned by calling the named nil-ary method. class-name.class : The Class
* object for the specified class should be used as the lock object.
* Describes the lock which guards a field or method.
*/
@Documented
@Target({ ElementType.FIELD, ElementType.METHOD })
@Retention(RetentionPolicy.CLASS)
public @interface GuardedBy {
/**
* The field or method to which this annotation is applied can only be
* accessed when holding a particular lock, which may be a built-in
* (synchronization) lock, or may be an explicit java.util.concurrent.Lock.
* Gets the lock which guards a field or method.
*
* The argument determines which lock guards the annotated field or method:
* this : The string literal "this" means that this field is guarded by the
* class in which it is defined. class-name.this : For inner classes, it may
* be necessary to disambiguate 'this'; the class-name.this designation
* allows you to specify which 'this' reference is intended itself : For
* reference fields only; the object to which the field refers. field-name :
* The lock object is referenced by the (instance or static) field specified
* by field-name. class-name.field-name : The lock object is reference by
* the static field specified by class-name.field-name. method-name() : The
* lock object is returned by calling the named nil-ary method.
* class-name.class : The Class object for the specified class should be
* used as the lock object.
*
* @return see description
* @return the lock which guards a field or method.
*/
String value();
}

View File

@ -22,31 +22,8 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/*
* Copyright (c) 2005 Brian Goetz
* Released under the Creative Commons Attribution License
* (http://creativecommons.org/licenses/by/2.5)
* Official home: http://www.jcip.net
*
* Any republication or derived work distributed in source code form
* must include this copyright and license notice.
*/
/**
* Immutable
*
* The class to which this annotation is applied is immutable. This means that
* its state cannot be seen to change by callers. Of necessity this means that
* all public fields are final, and that all public final reference fields refer
* to other immutable objects, and that methods do not publish references to any
* internal state which is mutable by implementation even if not by design.
* Immutable objects may still have internal mutable state for purposes of
* performance optimization; some state variables may be lazily computed, so
* long as they are computed from immutable state and that callers cannot tell
* the difference.
*
* Immutable objects are inherently thread-safe; they may be passed between
* threads or published without synchronization.
* Describes a type as immutable.
*/
@Documented
@Target(ElementType.TYPE)

View File

@ -22,23 +22,8 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/*
* Copyright (c) 2005 Brian Goetz
* Released under the Creative Commons Attribution License
* (http://creativecommons.org/licenses/by/2.5)
* Official home: http://www.jcip.net
*
* Any republication or derived work distributed in source code form
* must include this copyright and license notice.
*/
/**
* NotThreadSafe
*
* The class to which this annotation is applied is not thread-safe. This
* annotation primarily exists for clarifying the non-thread-safety of a class
* that might otherwise be assumed to be thread-safe, despite the fact that it
* is a bad idea to assume a class is thread-safe without good reason.
* Describes this type as not thread-safe.
*
* @see ThreadSafe
*/

View File

@ -22,22 +22,10 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/*
* Copyright (c) 2005 Brian Goetz and Tim Peierls
* Released under the Creative Commons Attribution License
* (http://creativecommons.org/licenses/by/2.5)
* Official home: http://www.jcip.net
*
* Any republication or derived work distributed in source code form
* must include this copyright and license notice.
*/
/**
* The class to which this annotation is applied is thread-safe. This means that
* no sequences of accesses (reads and writes to public fields, calls to public methods)
* may put the object into an invalid state, regardless of the interleaving of those actions
* by the runtime, and without requiring any additional synchronization or coordination on the
* part of the caller.
* Describes this type as thread-safe.
*
* @see NotThreadSafe
*/
@Documented
@Target(ElementType.TYPE)