• Home
• net.sf.m-m-m
• mmm-util-io
• 8.7.0
• source code
• FileUtilLimited.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

net.sf.mmm.util.file.api.FileUtilLimited Maven / Gradle / Ivy

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package net.sf.mmm.util.file.api;

import java.io.File;

/**
 * This is the interface for a collection of utility functions for {@link File} handling and manipulation.
 * 

 * NOTE:

 * Since Java7 there is also {@link java.nio.file.Files} that offers similar and additional features. However
 * this is not supported in limited environments such as e.g. GWT.
 *
 * @see net.sf.mmm.util.file.base.FileUtilLimitedImpl
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 5.0.0
 */
public interface FileUtilLimited {

  /** The path segment indicating the current folder itself. */
  String PATH_SEGMENT_CURRENT = ".";

  /** The path segment indicating the parent folder. */
  String PATH_SEGMENT_PARENT = "..";

  /**
   * The key of the {@link System#getProperty(String) system property} {@value}. It contains the home
   * directory of the user that started this JVM. 

   * Examples are {@code /home/mylogin} or {@code C:\Windows\Profiles\mylogin}.
   */
  String PROPERTY_USER_HOME = "user.home";

  /**
   * The key of the {@link System#getProperty(String) system property} {@value}. It contains the directory to
   * use for temporary files. 

   * Examples are {@code /tmp}, {@code C:\Temp} or {@code /usr/local/tomcat/temp}.
   */
  String PROPERTY_TMP_DIR = "java.io.tmpdir";

  /** An empty file array. */
  File[] NO_FILES = new File[0];

  /**
   * This method normalizes a given {@code path}. It will resolve ".." and "." segments, normalize backslashes
   * and remove duplicated slashes. Further it can resolve "~" at the beginning of the path (like in
   * bash-scripts, etc.). Therefore this method resolves the path in such situations (e.g. to
   * "/home/login/foo") and returns a physical path. 

   * Here are some examples assuming that {@code separator} is '/' (backslashes are NOT escaped):
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
{@code path}
{@code normalizePath(path)}
{@code "folder/subfolder//../.\some.file"}
{@code "folder/some.file"}
{@code "../.\some.file"}
{@code "../some.file"}
{@code "http://www.host.com/foo/bar/./test/.././.."}
{@code "http://www.host.com/foo"}
{@code "\\unc.host\printers\pr3761"}
{@code "\\unc.host\printers\pr3761"}
{@code "~/documents/index.html"}
{@link #PROPERTY_USER_HOME home}{@code + "/documents/index.html"}
{@code "~root/subfolder/../folder/.//index.html"}
{@code "/root/folder/index.html"}
   * ATTENTION:

   * Normalizing home-directories of other users (e.g. "~user/") makes various assumptions and is NOT
   * guaranteed to be correct in any case.
   *
   * @param path is the path to resolve.
   * @param separator is the character to use as {@link File#separatorChar file separator}.
   * @return the resolved path.
   */
  String normalizePath(String path, char separator);

  /**
   * This method is a shortcut for {@link #normalizePath(String, char) normalizePath}{@code (path,}
   * {@link File#separatorChar}{@code )}.
   *
   * @see #normalizePath(String, char)
   *
   * @param path is the path to resolve.
   * @return the resolved path.
   */
  String normalizePath(String path);

  /**
   * This method extracts the extension from the given {@code filename}. 

   * Example: {@link #getExtension(String) getExtension}{@code ("test.java")} would return {@code "java"}.
   * 

   * ATTENTION:

   * If the {@code filename} is just a dot followed by the extension (e.g. {@code ".java"}), the empty string
   * is returned.
   *
   * @param filename is the filename and may include an absolute or relative path.
   * @return the extension of the given {@code filename} excluding the dot in {@link String#toLowerCase()
   *         lowercase} or the empty string if NOT present.
   */
  String getExtension(String filename);

  /**
   * This method gets the basename of the given {@code filename} (path). The basename is the raw name
   * of the file without the {@link #getDirname(String) path}. 

   * Examples:
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
filename
{@link #getBasename(String) getBasename}{@code (filename)}
 
 
/
/
\/\
\
/.
.
/foo.bar
foo.bar
/foo/bar/
bar
c:\\
 
c:\\foo
foo
http://foo.org/bar
bar
   *
   * @param filename is the path to a file or directory.
   * @return the basename of the given {@code filename}.
   */
  String getBasename(String filename);

  /**
   * This method gets the directory-name of the given {@code filename} (path). 

   * Examples:
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * 
filename
{@link #getDirname(String)}
foo
.
/foo
/
/foo/bar
/foo
/foo/bar/
/foo
./foo/bar/
./foo
./foo/bar/../
./foo/bar
   *
   * @see #normalizePath(String)
   *
   * @param filename is the path to a file or directory.
   * @return the path to the directory containing the file denoted by the given {@code filename}.
   */
  String getDirname(String filename);

}