README
1Guava: Google Core Libraries for Java
2=====================================
3
4Requires JDK 1.5 or higher.
5
6Project page:
7 http://guava-libraries.googlecode.com
8
9Report a defect or feature request here:
10 http://code.google.com/p/guava-libraries/issues/entry
11
12Ask "how-to" and "why-didn't-it-work" questions at:
13 http://www.stackoverflow.com/questions/ask (use the "guava" tag)
14
15For open-ended questions and discussion:
16 http://groups.google.com/group/guava-discuss
17
18Subscribe to project updates in your feed reader:
19 http://code.google.com/feeds/p/guava-libraries/updates/basic
20
21IMPORTANT WARNINGS
22------------------
23
241. APIs marked with the @Beta annotation at the class or method level
25are subject to change. They can be modified in any way, or even
26removed, at any time. If your code is a library itself (i.e. it is
27used on the CLASSPATH of users outside your own control), you should
28not use beta APIs, unless you repackage them (e.g. using ProGuard).
29
302. Deprecated non-beta APIs will be removed eighteen months after the
31release in which they are first deprecated. You must fix your
32references before this time. If you don't, any manner of breakage
33could result (you are not guaranteed a compilation error).
34
353. Serialized forms of ALL objects are subject to change. Do not
36persist these and assume they can be read by a future version of the
37library.
38
394. Our classes are not designed to protect against a malicious caller.
40You should not use them for communication between trusted and
41untrusted code.
42
435. We unit-test and benchmark the libraries using only OpenJDK 1.6 on
44Linux. Some features, especially in com.google.common.io, may not work
45correctly in other environments.
46
47
README.android
README.maven
1These folders host the maven metadata which are used to
2build release binaries for hosting in the central maven
3repositories. These are not considered the "canonical"
4build, but are maintained seperately by (a) volunteer(s)
5with an interest in easy use of Guava by the Maven build
6system.
7
8As a convenience, these folders have been set up to
9provide alternate packaging of the sub-pmodules, which
10correspond to their respective java packages, with
11sources symbolically linked back to the main project.
12This will work to allow command-line builds on MacOS X
13or other Unix platforms which support symbolic linking,
14but is not known to work on Windows platforms.
15(Obviously the deployed binaries in maven repostories
16will work fine on any compliant JVM).
17
18The maintainers of these metadata have used M2Eclipse
19to import these projects directly into Eclipse. Please
20remember that this codebase uses @Override annotations
21on methods which implement an interface method, and
22therefore require a JDK 1.6 (or newer 1.5 with the
23appropriate fix) to support this behaviour. Executing
24Maven with an appropriate JAVA_HOME env is sufficient,
25and these metadata do not have toolchain restrictions
26currently set up.
27
28Christian
29cgruber@google.com
30