org.zeroturnaround.zip.NameMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zt-zip Show documentation

The project is intended to have a small, easy and fast library to process ZIP archives. Either create, modify or explode them. On disk or in memory.

There is a newer version: 1.17

Show newest version

/**
 *    Copyright (C) 2012 ZeroTurnaround LLC 
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.zeroturnaround.zip;

/**
 * Call-back for filtering and renaming ZIP entries while packing or unpacking.
 *  
 * @author Rein Raudjärv
 * 
 * @see ZipUtil
 */
public interface NameMapper {
  
  /**
   * @param name original name.
   * @return name to be stored in the ZIP file or the destination directory,
   *    null means that the entry will be skipped.
   */
  String map(String name);
  
}