net.sf.mmm.util.file.NlsBundleUtilFileRoot Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mmm-util-io Show documentation
Utilities for input/output and streaming.
The newest version!
/* 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;

import javax.inject.Named;

import net.sf.mmm.util.nls.api.NlsBundle;
import net.sf.mmm.util.nls.api.NlsBundleMessage;
import net.sf.mmm.util.nls.api.NlsMessage;

/**
 * This interface holds the {@link NlsBundle internationalized messages} for this module.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 5.0.0
 */
public interface NlsBundleUtilFileRoot extends NlsBundle {

  /**
   * @see net.sf.mmm.util.file.api.FileAlreadyExistsException
   *
   * @param file is the name or path of the file.
   * @param directory {@code true} if the given {@code file} is a directory, {@code false} otherwise or if unknown.
   * @return the {@link NlsMessage}
   */
  @NlsBundleMessage("The {directory,choice,(?==true)'directory'(else)'file'} \"{file}\" already exists!")
  NlsMessage errorFileAlreadyExists(@Named("file") String file, @Named("directory") boolean directory);

  /**
   * @see net.sf.mmm.util.file.api.FileNotExistsException
   *
   * @param file is the name or path of the file.
   * @param directory {@code true} if the given {@code file} is a directory, {@code false} otherwise or if unknown.
   * @return the {@link NlsMessage}
   */
  @NlsBundleMessage("The {directory,choice,(?==true)'directory'(else)'file'} \"{file}\" does not exist!")
  NlsMessage errorFileNotExists(@Named("file") String file, @Named("directory") boolean directory);

  /**
   * @see net.sf.mmm.util.file.api.FileCreationFailedException
   *
   * @param file is the name or path of the file.
   * @param directory {@code true} if the given {@code file} is a directory, {@code false} otherwise or if unknown.
   * @return the {@link NlsMessage}
   */
  @NlsBundleMessage("The {directory,choice,(?==true)'directory'(else)'file'} \"{file}\" could not be created!")
  NlsMessage errorFileCreationFailed(@Named("file") String file, @Named("directory") boolean directory);

  /**
   * @see net.sf.mmm.util.file.api.FilePermissionException
   *
   * @param file is the name or path of the file.
   * @param directory {@code true} if the given {@code file} is a directory, {@code false} otherwise or if unknown.
   * @return the {@link NlsMessage}
   * @since 7.4.0
   */
  @NlsBundleMessage("Insufficient permissions for {directory,choice,(?==true)'directory'(else)'file'} \"{file}\"!")
  NlsMessage errorFilePermission(@Named("file") String file, @Named("directory") boolean directory);

  /**
   * @see net.sf.mmm.util.file.api.FileAttributeModificationFailedException
   *
   * @param file is the name or path of the file.
   * @param directory {@code true} if the given {@code file} is a directory, {@code false} otherwise or if unknown.
   * @return the {@link NlsMessage}
   */
  @NlsBundleMessage("The attributes of the {directory,choice,(?==true)'directory'(else)'file'} \"{file}\" could not be modified!")
  NlsMessage errorFileAttributeModificationFailed(@Named("file") String file, @Named("directory") boolean directory);

  /**
   * @see net.sf.mmm.util.file.api.FileDeletionFailedException
   *
   * @param file is the name or path of the file.
   * @param directory {@code true} if the given {@code file} is a directory, {@code false} otherwise or if unknown.
   * @return the {@link NlsMessage}
   */
  @NlsBundleMessage("The {directory,choice,(?==true)'directory'(else)'file'} \"{file}\" could not be deleted!")
  NlsMessage errorFileDeletionFailed(@Named("file") String file, @Named("directory") boolean directory);

}