├── .gitignore ├── src └── main │ └── java │ └── net │ └── jcip │ └── annotations │ ├── NotThreadSafe.java │ ├── ThreadSafe.java │ ├── Immutable.java │ └── GuardedBy.java ├── README.md ├── pom.xml └── LICENSE.txt /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | .project 3 | .classpath 4 | .settings 5 | *.iml 6 | *.ipr 7 | *.iws 8 | target/ 9 | 10 | -------------------------------------------------------------------------------- /src/main/java/net/jcip/annotations/NotThreadSafe.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2013 Stephen Connolly. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.jcip.annotations; 18 | 19 | import java.lang.annotation.Documented; 20 | import java.lang.annotation.Retention; 21 | import java.lang.annotation.Target; 22 | 23 | import static java.lang.annotation.ElementType.TYPE; 24 | import static java.lang.annotation.RetentionPolicy.RUNTIME; 25 | 26 | /** 27 | * The presence of this annotation indicates that the author believes the class is not thread-safe. 28 | * The absence of this annotation does not indicate that the class is thread-safe, instead this annotation is for 29 | * cases where a naïve assumption could be easily made that the class is thread-safe. In general, it is a bad plan 30 | * to assume a class is thread safe without good reason. 31 | */ 32 | @Documented 33 | @Target(TYPE) 34 | @Retention(RUNTIME) 35 | public @interface NotThreadSafe { 36 | } 37 | -------------------------------------------------------------------------------- /src/main/java/net/jcip/annotations/ThreadSafe.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2013 Stephen Connolly. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.jcip.annotations; 18 | 19 | import java.lang.annotation.Documented; 20 | import java.lang.annotation.Retention; 21 | import java.lang.annotation.Target; 22 | 23 | import static java.lang.annotation.ElementType.TYPE; 24 | import static java.lang.annotation.RetentionPolicy.RUNTIME; 25 | 26 | /** 27 | * The presence of this annotation indicates that the author believes the class to be thread-safe. As such, there should 28 | * be no sequence of accessing the public methods or fields that could put an instance of this class into an invalid 29 | * state, irrespective of any rearrangement of those operations by the Java Runtime and without introducing any 30 | * requirements for synchronization or coordination by the caller/accessor. 31 | */ 32 | @Documented 33 | @Target(TYPE) 34 | @Retention(RUNTIME) 35 | public @interface ThreadSafe { 36 | } 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 16 | Introduction 17 | ------------ 18 | 19 | This is a cleanroom implementation of the [JCIP][1] Annotations. 20 | 21 | I used only the Javadoc of the [JCIP][1] annotations. 22 | 23 | At no time did I look at the original Findbugs source code. 24 | 25 | Rational 26 | -------- 27 | 28 | The JCIP Annotations are really useful, however they are released 29 | under the [Creative Commons Attribution License] 30 | (http://creativecommons.org/licenses/by/2.5), which is 31 | [not recommended for licensing software](http://wiki.creativecommons.org/FAQ#Can_I_use_a_Creative_Commons_license_for_software.3F) 32 | and may therefore cause issues for some people. 33 | 34 | Credits 35 | ------- 36 | 37 | Brian Goetz and Tim Peierls you guys are f*cking awesome, and I didn't 38 | realize how bad a Java developer I was until I saw that book. As soon as 39 | I saw the Yuk face listing on page 32, I *knew* I had to buy the book. 40 | 41 | If there is *one* book every Java developer should have, [JCIP][1] is **that** book. 42 | 43 | [1]: http://jcip.net -------------------------------------------------------------------------------- /src/main/java/net/jcip/annotations/Immutable.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2013 Stephen Connolly. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.jcip.annotations; 18 | 19 | import java.lang.annotation.Documented; 20 | import java.lang.annotation.Retention; 21 | import java.lang.annotation.Target; 22 | 23 | import static java.lang.annotation.ElementType.TYPE; 24 | import static java.lang.annotation.RetentionPolicy.RUNTIME; 25 | 26 | /** 27 | * The presence of this annotation indicates that the author believes the class to be immutable and hence inherently 28 | * thread-safe. An immutable class is one where the state of an instance cannot be seen to change. As a result 29 | * 34 | * Performance optimization may mean that instances of an immutable class may have mutable internal state. The 35 | * critical point is that callers cannot tell the difference. For example {@link String} is an immutable class, despite 36 | * having an internal int that is non-final but used as a cache for {@link String#hashCode()}. 37 | *

38 | * Immutable objects are inherently thread-safe; they may be passed between threads or published without 39 | * synchronization. 40 | */ 41 | @Documented 42 | @Target(TYPE) 43 | @Retention(RUNTIME) 44 | public @interface Immutable { 45 | } 46 | -------------------------------------------------------------------------------- /src/main/java/net/jcip/annotations/GuardedBy.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2013 Stephen Connolly. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.jcip.annotations; 18 | 19 | import java.lang.annotation.Documented; 20 | import java.lang.annotation.Retention; 21 | import java.lang.annotation.Target; 22 | 23 | import static java.lang.annotation.ElementType.FIELD; 24 | import static java.lang.annotation.ElementType.METHOD; 25 | import static java.lang.annotation.RetentionPolicy.RUNTIME; 26 | 27 | /** 28 | * The presence of this annotation indicates that the field or method must only be accessed when holding the specified 29 | * lock. 30 | */ 31 | @Documented 32 | @Target(value = {FIELD, METHOD}) 33 | @Retention(RUNTIME) 34 | public @interface GuardedBy { 35 | /** 36 | * The specified lock that guards the annotated field or method. Valid values are: 37 | *

55 | * 56 | * @return The specified lock that guards the annotated field or method 57 | */ 58 | String value(); 59 | } 60 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 17 | 18 | 4.0.0 19 | 20 | 21 | org.sonatype.oss 22 | oss-parent 23 | 7 24 | 25 | 26 | com.github.stephenc.jcip 27 | jcip-annotations 28 | bundle 29 | 1.0-2-SNAPSHOT 30 | 31 | JCIP Annotations under Apache License 32 | 33 | A clean room implementation of the JCIP Annotations based entirely on the specification provided by the javadocs. 34 | 35 | http://stephenc.github.com/jcip-annotations 36 | 2013 37 | 38 | 39 | Apache License, Version 2.0 40 | http://www.apache.org/licenses/LICENSE-2.0.txt 41 | repo 42 | 43 | 44 | 45 | 46 | 47 | stephenc 48 | Stephen Connolly 49 | 50 | developer 51 | 52 | 53 | 54 | 55 | 56 | 2.2.1 57 | 58 | 59 | 60 | scm:git:git://github.com/stephenc/jcip-annotations.git 61 | scm:git:git@github.com:stephenc/jcip-annotations.git 62 | http://github.com/stephenc/jcip-annotations/tree/master/ 63 | HEAD 64 | 65 | 66 | github 67 | http://github.com/stephenc/jcip-annotations/issues 68 | 69 | 70 | 71 | github.com 72 | gitsite:git@github.com/stephenc/jcip-annotations.git 73 | 74 | 75 | 76 | 77 | UTF-8 78 | UTF-8 79 | UTF-8 80 | 81 | 82 | 83 | 84 | 85 | 86 | maven-bundle-plugin 87 | 2.3.7 88 | 89 | 90 | maven-clean-plugin 91 | 2.5 92 | 93 | 94 | maven-compiler-plugin 95 | 3.0 96 | 97 | 98 | maven-deploy-plugin 99 | 2.7 100 | 101 | 102 | maven-install-plugin 103 | 2.4 104 | 105 | 106 | maven-jar-plugin 107 | 2.4 108 | 109 | 110 | maven-release-plugin 111 | 2.4 112 | 113 | 114 | maven-resources-plugin 115 | 2.6 116 | 117 | 118 | maven-site-plugin 119 | 3.2 120 | 121 | 122 | com.github.stephenc.wagon 123 | wagon-gitsite 124 | 0.4.1 125 | 126 | 127 | org.apache.maven.doxia 128 | doxia-module-markdown 129 | 1.3 130 | 131 | 132 | 133 | 134 | maven-surefire-plugin 135 | 2.13 136 | 137 | 138 | 139 | 140 | 141 | maven-compiler-plugin 142 | 143 | 1.5 144 | 1.5 145 | 146 | 147 | 148 | org.apache.felix 149 | maven-bundle-plugin 150 | true 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | org.apache.maven.plugins 159 | maven-project-info-reports-plugin 160 | 2.6 161 | 162 | 163 | org.apache.maven.plugins 164 | maven-javadoc-plugin 165 | 2.9 166 | 167 | 168 | org.apache.maven.plugins 169 | maven-jxr-plugin 170 | 2.3 171 | 172 | 173 | 174 | 175 | 176 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------