| Line | Hits | Note | Source |
|---|---|---|---|
| 1 | /* | ||
| 2 | * $Id: FsConnectionFactory.java 1011 2008-06-16 17:57:36Z amandel $ | ||
| 3 | * | ||
| 4 | * Copyright 2006, The jCoderZ.org Project. All rights reserved. | ||
| 5 | * | ||
| 6 | * Redistribution and use in source and binary forms, with or without | ||
| 7 | * modification, are permitted provided that the following conditions are | ||
| 8 | * met: | ||
| 9 | * | ||
| 10 | * * Redistributions of source code must retain the above copyright | ||
| 11 | * notice, this list of conditions and the following disclaimer. | ||
| 12 | * * Redistributions in binary form must reproduce the above | ||
| 13 | * copyright notice, this list of conditions and the following | ||
| 14 | * disclaimer in the documentation and/or other materials | ||
| 15 | * provided with the distribution. | ||
| 16 | * * Neither the name of the jCoderZ.org Project nor the names of | ||
| 17 | * its contributors may be used to endorse or promote products | ||
| 18 | * derived from this software without specific prior written | ||
| 19 | * permission. | ||
| 20 | * | ||
| 21 | * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND | ||
| 22 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 23 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| 24 | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS | ||
| 25 | * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| 26 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| 27 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR | ||
| 28 | * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, | ||
| 29 | * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR | ||
| 30 | * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF | ||
| 31 | * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| 32 | */ | ||
| 33 | package org.jcoderz.commons.connector.file; | ||
| 34 | |||
| 35 | import java.io.Serializable; | ||
| 36 | import java.util.Properties; | ||
| 37 | |||
| 38 | import javax.resource.Referenceable; | ||
| 39 | import javax.resource.ResourceException; | ||
| 40 | |||
| 41 | /** | ||
| 42 | * This factory provides an interface to get a connection to the File System. | ||
| 43 | * The File System Connector does not provide the | ||
| 44 | * {@link javax.resource.cci} interface. A connector's client should use | ||
| 45 | * this factory to get a connection to the File System instead. | ||
| 46 | * | ||
| 47 | */ | ||
| 48 | (1) | public interface FsConnectionFactory | |
| 49 | extends Serializable, Referenceable | ||
| 50 | { | ||
| 51 | /** Default value for chunk size, 20 MByte. */ | ||
| 52 | (2) | static final (2)long FILE_TRANSFER_CHUNK_SIZE_DEF_VALUE = 20000000L; | |
| 53 | |||
| 54 | /** Property temp dir. */ | ||
| 55 | String PROP_TEMP_DIR = "TempDir"; | ||
| 56 | |||
| 57 | /** Property to define the chunk size used while file transfering. */ | ||
| 58 | String PROP_FILE_TRANSFER_CHUNK_SIZE = "FileTransferChunkSize"; | ||
| 59 | |||
| 60 | /** | ||
| 61 | * Returns a connection to the File System. | ||
| 62 | * @return a connection to the File System. | ||
| 63 | * @throws ResourceException Failed to get a connection. | ||
| 64 | */ | ||
| 65 | FsConnection getConnection () | ||
| 66 | throws ResourceException; | ||
| 67 | /** | ||
| 68 | * Returns a connection to the File System. | ||
| 69 | * @param props The properties to use. | ||
| 70 | * @return a connection to the File System. | ||
| 71 | * @throws ResourceException Failed to get a connection. | ||
| 72 | */ | ||
| 73 | FsConnection getConnection (Properties props) | ||
| 74 | throws ResourceException; | ||
| 75 | } | ||
| 76 |
|
|
(3) | Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag 'ResourceException'. | |||
|
|
(1) | 48 | : | 0 | Type Javadoc comment is missing an @author tag. |
|
|
(2) | 52 | : | 17 | Avoid modifiers which are implied by the context |