KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > alfresco > repo > content > RandomAccessContent


1 /*
2  * Copyright (C) 2005 Alfresco, Inc.
3  *
4  * Licensed under the Mozilla Public License version 1.1
5  * with a permitted attribution clause. You may obtain a
6  * copy of the License at
7  *
8  * http://www.alfresco.org/legal/license.txt
9  *
10  * Unless required by applicable law or agreed to in writing,
11  * software distributed under the License is distributed on an
12  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13  * either express or implied. See the License for the specific
14  * language governing permissions and limitations under the
15  * License.
16  */
17 package org.alfresco.repo.content;
18
19 import java.nio.channels.FileChannel JavaDoc;
20
21 import org.alfresco.service.cmr.repository.ContentIOException;
22
23 /**
24  * Supplementary interface for content readers and writers that allow random-access to
25  * the underlying content.
26  * <p>
27  * The use of this interface by a client <b>may</b> preclude the use of any other
28  * access to the underlying content - this depends on the underlying implementation.
29  *
30  * @author Derek Hulley
31  */
32 public interface RandomAccessContent
33 {
34     /**
35      * @return Returns true if the content can be written to
36      */
37     public boolean canWrite();
38     
39     /**
40      * Get a channel to access the content. The channel's behaviour is similar to that
41      * when a <tt>FileChannel</tt> is retrieved using {@link java.io.RandomAccessFile#getChannel()}.
42      *
43      * @return Returns a channel to access the content
44      * @throws ContentIOException
45      *
46      * @see #canWrite()
47      * @see java.io.RandomAccessFile#getChannel()
48      */
49     public FileChannel JavaDoc getChannel() throws ContentIOException;
50 }
51
Popular Tags