| 1 |
/** |
| 2 |
* Copyright (c) 2012-2017, jcabi.com |
| 3 |
* All rights reserved. |
| 4 |
* |
| 5 |
* Redistribution and use in source and binary forms, with or without |
| 6 |
* modification, are permitted provided that the following conditions |
| 7 |
* are met: 1) Redistributions of source code must retain the above |
| 8 |
* copyright notice, this list of conditions and the following |
| 9 |
* disclaimer. 2) Redistributions in binary form must reproduce the above |
| 10 |
* copyright notice, this list of conditions and the following |
| 11 |
* disclaimer in the documentation and/or other materials provided |
| 12 |
* with the distribution. 3) Neither the name of the jcabi.com nor |
| 13 |
* the names of its contributors may be used to endorse or promote |
| 14 |
* products derived from this software without specific prior written |
| 15 |
* permission. |
| 16 |
* |
| 17 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 18 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT |
| 19 |
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND |
| 20 |
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL |
| 21 |
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, |
| 22 |
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| 23 |
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| 24 |
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 25 |
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| 26 |
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 27 |
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 28 |
* OF THE POSSIBILITY OF SUCH DAMAGE. |
| 29 |
*/ |
| 30 |
package com.jcabi.aspects; |
| 31 |
|
| 32 |
import java.lang.annotation.Documented; |
| 33 |
import java.lang.annotation.ElementType; |
| 34 |
import java.lang.annotation.Retention; |
| 35 |
import java.lang.annotation.RetentionPolicy; |
| 36 |
import java.lang.annotation.Target; |
| 37 |
|
| 38 |
/** |
| 39 |
* Annotates an immutable class. |
| 40 |
* |
| 41 |
* <p>For example: |
| 42 |
* |
| 43 |
* <pre> @Immutable |
| 44 |
* public class Foo { |
| 45 |
* private String data; |
| 46 |
* }</pre> |
| 47 |
* |
| 48 |
* <p>As soon as you try to instantiate this class a runtime exception |
| 49 |
* will be thrown, because this class is mutable. |
| 50 |
* |
| 51 |
* @author Yegor Bugayenko ([email protected]) |
| 52 |
* @version $Id: e2730b444ca7535db6262029bd71706ea211acb8 $ |
| 53 |
* @since 0.7.8 |
| 54 |
* @see <a href="http://aspects.jcabi.com">http://aspects.jcabi.com/</a> |
| 55 |
* @see <a href="http://www.yegor256.com/2014/06/09/objects-should-be-immutable.html">Objects Should Be Immutable, by Yegor Bugayenko</a> |
| 56 |
*/ |
| 57 |
@Documented |
| 58 |
@Retention(RetentionPolicy.RUNTIME) |
| 59 |
@Target(ElementType.TYPE) |
| 60 |
public @interface Immutable { |
| 61 |
/** |
| 62 |
* Identifies that an array-type field should be considered immutable. Note |
| 63 |
* that for an array to be considered immutable, its component type must |
| 64 |
* also be immutable. |
| 65 |
* @since 0.17 |
| 66 |
* @todo #33 Let's prevent modifications to arrays having this annotation, |
| 67 |
* somehow. Perhaps we can create an aspect that will throw an exception |
| 68 |
* should something try to write into the array. See |
| 69 |
* https://bugs.eclipse.org/bugs/show_bug.cgi?id=157031 |
| 70 |
*/ |
| 71 |
@Documented |
| 72 |
@Retention(RetentionPolicy.RUNTIME) |
| 73 |
@Target(ElementType.FIELD) |
| 74 |
public @interface Array { |
| 75 |
} |
| 76 |
} |