com.caucho.v5.io.Path Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of baratine Show documentation

A reactive Java web server.

There is a newer version: 1.0.1

/*
 * Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
 *
 * This file is part of Baratine(TM)(TM)
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Baratine is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Baratine 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Baratine; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.v5.io;

import java.io.IOException;


/**
 * A virtual filesystem path, essentially represented by a URL.
 * Its API resembles a combination of  the JDK File object and the URL object.
 *
 * Paths are, in general, given with the canonical file separator of
 * forward slash, '/'.  The filesystems will take care of any necessary
 * translation.
 *
 * 
Currently available filesystems:
 * 

 * file:/path/to/file
Java file
 * 
http://host:port/path/name?query
HTTP request
 * 
tcp://host:port
Raw TCP connection
 * 
mailto:user@host?subject=foo&cc=user2
Mail to a user.
 * 
log:/group/subgroup/item
Logging based on the configuration file.
 * 
stdout:
System.out
 * 
stderr:
System.err
 * 
null:
The equivalent of /dev/null
 * 
 */
public interface Path extends Source, Comparable
{
  boolean exists();

  String getNativePath();
  boolean remove() throws IOException;

  Path lookup(String string);

  String getURL();

  String getPath();
}