1/*
2 * Copyright 2008 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package org.mockftpserver.fake.filesystem;
18
19/**
20 * Interface for an object that can format a file system directory listing.
21 *
22 * @author Chris Mair
23 * @version $Revision$ - $Date$
24 */
25public interface DirectoryListingFormatter {
26
27    /**
28     * Format the directory listing for a single file/directory entry.
29     *
30     * @param fileSystemEntry - the FileSystemEntry for a single file system entry
31     * @return the formatted directory listing
32     */
33    String format(FileSystemEntry fileSystemEntry);
34
35}