com.foreach.common.filemanager.services.PathGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-file-manager Show documentation

A number of general purpose libraries for Java. Dependencies are kept minimal but Spring framework is considered a base requirement for most libraries.

The newest version!

/*
 * Copyright 2014 the original author or authors
 *
 * 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 com.foreach.common.filemanager.services;

/**
 * PathGenerator interface can be used to dynamically generate a path
 * to distribute files in a repository.
 *
 * @see LocalFileRepository
 * @see DateFormatPathGenerator
 */
@FunctionalInterface
public interface PathGenerator
{
	/**
	 * Generate a path for a new file.
	 *
	 * @return Path string or null if no sub folder should be used.
	 */
	String generatePath();
}