1 /*
2 * Copyright 2002-2011 the original author or authors.
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 org.springframework.core.io;
18
19 import java.io.IOException;
20 import java.io.OutputStream;
21
22 /**
23 * Extended interface for a resource that supports writing to it.
24 * Provides an {@link #getOutputStream() OutputStream accessor}.
25 *
26 * @author Juergen Hoeller
27 * @since 3.1
28 * @see java.io.OutputStream
29 */
30 public interface WritableResource extends Resource {
31
32 /**
33 * Return whether the contents of this resource can be modified,
34 * e.g. via {@link #getOutputStream()} or {@link #getFile()}.
35 * <p>Will be <code>true</code> for typical resource descriptors;
36 * note that actual content writing may still fail when attempted.
37 * However, a value of <code>false</code> is a definitive indication
38 * that the resource content cannot be modified.
39 * @see #getOutputStream()
40 * @see #isReadable()
41 */
42 boolean isWritable();
43
44 /**
45 * Return an {@link OutputStream} for the underlying resource,
46 * allowing to (over-)write its content.
47 * @throws IOException if the stream could not be opened
48 * @see #getInputStream()
49 */
50 OutputStream getOutputStream() throws IOException;
51
52 }