1*ba8755cbSAndroid Build Coastguard Worker<?xml version="1.0"?> 2*ba8755cbSAndroid Build Coastguard Worker<!-- 3*ba8755cbSAndroid Build Coastguard Worker Licensed to the Apache Software Foundation (ASF) under one or more 4*ba8755cbSAndroid Build Coastguard Worker contributor license agreements. See the NOTICE file distributed with 5*ba8755cbSAndroid Build Coastguard Worker this work for additional information regarding copyright ownership. 6*ba8755cbSAndroid Build Coastguard Worker The ASF licenses this file to You under the Apache License, Version 2.0 7*ba8755cbSAndroid Build Coastguard Worker (the "License"); you may not use this file except in compliance with 8*ba8755cbSAndroid Build Coastguard Worker the License. You may obtain a copy of the License at 9*ba8755cbSAndroid Build Coastguard Worker 10*ba8755cbSAndroid Build Coastguard Worker http://www.apache.org/licenses/LICENSE-2.0 11*ba8755cbSAndroid Build Coastguard Worker 12*ba8755cbSAndroid Build Coastguard Worker Unless required by applicable law or agreed to in writing, software 13*ba8755cbSAndroid Build Coastguard Worker distributed under the License is distributed on an "AS IS" BASIS, 14*ba8755cbSAndroid Build Coastguard Worker WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15*ba8755cbSAndroid Build Coastguard Worker See the License for the specific language governing permissions and 16*ba8755cbSAndroid Build Coastguard Worker limitations under the License. 17*ba8755cbSAndroid Build Coastguard Worker--> 18*ba8755cbSAndroid Build Coastguard Worker<document> 19*ba8755cbSAndroid Build Coastguard Worker <properties> 20*ba8755cbSAndroid Build Coastguard Worker <title>Conventions</title> 21*ba8755cbSAndroid Build Coastguard Worker </properties> 22*ba8755cbSAndroid Build Coastguard Worker 23*ba8755cbSAndroid Build Coastguard Worker <body> 24*ba8755cbSAndroid Build Coastguard Worker <section name="Code Style"> 25*ba8755cbSAndroid Build Coastguard Worker <p> 26*ba8755cbSAndroid Build Coastguard Worker The developers of this component decided to follow the recommended standards 27*ba8755cbSAndroid Build Coastguard Worker but not to include Checkstyle (or similar tools) into Commons Compress. 28*ba8755cbSAndroid Build Coastguard Worker </p> 29*ba8755cbSAndroid Build Coastguard Worker </section> 30*ba8755cbSAndroid Build Coastguard Worker <section name="Multithreading"> 31*ba8755cbSAndroid Build Coastguard Worker <p> 32*ba8755cbSAndroid Build Coastguard Worker Commons Compress does not aim to be threadsafe at the moment. But the developers 33*ba8755cbSAndroid Build Coastguard Worker agreed to document multithreading behaviour in the javadocs. 34*ba8755cbSAndroid Build Coastguard Worker </p> 35*ba8755cbSAndroid Build Coastguard Worker <p> 36*ba8755cbSAndroid Build Coastguard Worker We use some of the annotations from 37*ba8755cbSAndroid Build Coastguard Worker <a href="http://jcip.net/annotations/doc/net/jcip/annotations/package-summary.html">JCIP</a> 38*ba8755cbSAndroid Build Coastguard Worker as Javadoc tags. The used tags are: 39*ba8755cbSAndroid Build Coastguard Worker 40*ba8755cbSAndroid Build Coastguard Worker <ul> 41*ba8755cbSAndroid Build Coastguard Worker <li>@GuardedBy (field or method)</li> 42*ba8755cbSAndroid Build Coastguard Worker <li>@Immutable (class)</li> 43*ba8755cbSAndroid Build Coastguard Worker <li>@NotThreadSafe (class)</li> 44*ba8755cbSAndroid Build Coastguard Worker <li>@ThreadSafe (class)</li> 45*ba8755cbSAndroid Build Coastguard Worker </ul> 46*ba8755cbSAndroid Build Coastguard Worker 47*ba8755cbSAndroid Build Coastguard Worker For example: 48*ba8755cbSAndroid Build Coastguard Worker <source> 49*ba8755cbSAndroid Build Coastguard Worker/** 50*ba8755cbSAndroid Build Coastguard Worker * Utility class that represents a four byte integer with conversion 51*ba8755cbSAndroid Build Coastguard Worker * rules for the big endian byte order of ZIP files. 52*ba8755cbSAndroid Build Coastguard Worker * 53*ba8755cbSAndroid Build Coastguard Worker * @Immutable 54*ba8755cbSAndroid Build Coastguard Worker */ 55*ba8755cbSAndroid Build Coastguard Workerpublic final class ZipLong implements Cloneable { 56*ba8755cbSAndroid Build Coastguard Worker </source> 57*ba8755cbSAndroid Build Coastguard Worker 58*ba8755cbSAndroid Build Coastguard Worker and: 59*ba8755cbSAndroid Build Coastguard Worker 60*ba8755cbSAndroid Build Coastguard Worker <source> 61*ba8755cbSAndroid Build Coastguard Workerprivate final char [] highChars; 62*ba8755cbSAndroid Build Coastguard Worker//@GuardedBy("this") 63*ba8755cbSAndroid Build Coastguard Workerprivate Simple8BitZipEncoding encoding; 64*ba8755cbSAndroid Build Coastguard Worker </source> 65*ba8755cbSAndroid Build Coastguard Worker </p> 66*ba8755cbSAndroid Build Coastguard Worker </section> 67*ba8755cbSAndroid Build Coastguard Worker 68*ba8755cbSAndroid Build Coastguard Worker </body> 69*ba8755cbSAndroid Build Coastguard Worker</document> 70