1 package org.springframework.roo.file.undo;
2
3 import java.io.File;
4
5 /**
6 * Interface to support {@link UndoableOperation} implementations rendering log messages with filename
7 * conventions applicable to the caller.
8 *
9 * <p>
10 * This interface is primarily intended to allow more meaningful paths to be displayed than those
11 * available directly via {@link File}.
12 *
13 * @author Ben Alex
14 * @since 1.0
15 *
16 */
17 public interface FilenameResolver {
18 /**
19 * Resolves the presented {@link File} into a meaningful name for display purposes.
20 *
21 * @param file to resolve (required)
22 * @return a string-based representation of the file name (never null or empty)
23 */
24 String getMeaningfulName(File file);
25 }