com.hfg.util.io.RemoteFile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.util.io;

import java.util.Calendar;
import java.io.InputStream;
import java.io.IOException;
import java.io.File;
import java.io.OutputStream;

//------------------------------------------------------------------------------
/**
 * Interface for remote files
 *
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public interface RemoteFile
{
   public String getName();

   public String getPath();

   /**
    The requested path may differ from getPath() if the requested path was a symbolic link.
    @return The (unwildcarded) path as it was originally requested.
    */
   public String getRequestedPath();

   public String getURL();

   public long getSize();

   public Calendar getTimestamp();

   public InputStream getInputStream() throws IOException;

   public long writeToStream(OutputStream stream) throws IOException;

   /**
    Copies the remote file to the specified local directory. If a local file exists and
    is up-to-date (same size and an equivalent or newer last modified time),
    no transfer is done.
    @return Whether or not the file was actually transferred.
    */
   public boolean writeToLocalDir(File inLocalDir) throws IOException;

   /**
    Copies the remote file to the specified local file. If the local file exists and
    is up-to-date (same size and an equivalent or newer last modified time),
    no transfer is done.
    @return Whether or not the file was actually transferred.
    */
   public boolean writeToLocalFile(File inLocalFile) throws IOException;

   /**
    Copies the remote file to the specified local root dir plus the file's remote path.
    If the local file exists and is up-to-date (same size and an equivalent or newer last modified time),
    no transfer is done.
    @return Whether or not the file was actually transferred.
    */
   public boolean copyLocallyPreservingPath(File inLocalRootDir) throws IOException;
}