• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2007 Google Inc.
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 com.google.common.io;
18 
19 /**
20  * This package contains utility methods and classes for working with Java I/O,
21  * for example input streams, output streams, readers, writers, and files.
22  *
23  * <p>Many of the methods are based on the
24  * {@link com.google.common.io.InputSupplier} and
25  * {@link com.google.common.io.OutputSupplier} interfaces. They are used as
26  * factories for I/O objects that might throw {@link java.io.IOException} when
27  * being created. The advantage of using a factory is that the helper methods in
28  * this package can take care of closing the resource properly, even if an
29  * exception is thrown. The {@link com.google.common.io.ByteStreams},
30  * {@link com.google.common.io.CharStreams}, and
31  * {@link com.google.common.io.Files} classes all have static helper methods to
32  * create new factories and to work with them.
33  *
34  * <p>The methods of this package always throw {@link NullPointerException} in
35  * response to a null value being supplied for any parameter that is not
36  * explicitly annotated as being {@link javax.annotation.Nullable}.
37  *
38  * @author Chris Nokleberg
39  */
40