com.anrisoftware.globalpom.fileresourcemanager.Resource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of globalpomutils-fileresources Show documentation

Saves and loads resources to files in atomic access.

The newest version!

/*
 * Copyright 2013-2025 Erwin Müller 
 *
 * 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.anrisoftware.globalpom.fileresourcemanager;

/*-
 * #%L
 * Global POM Utilities :: File Resources Manager
 * %%
 * Copyright (C) 2013 - 2018 Advanced Natural Research Institute
 * %%
 * 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.
 * #L%
 */

import java.io.OutputStream;

/**
 * Resource that is saved.
 * 
 * @author Erwin Mueller, [email protected]
 * @since 1.8
 */
public interface Resource {

	/**
	 * Returns the name of the resource.
	 * 
	 * @return the {@link String} name.
	 */
	String getName();

	/**
	 * Saves the resource in the specified stream.
	 * 
	 * @param stream
	 *            the {@link OutputStream}.
	 * 
	 * @throws Exception
	 *             if some error occurs while saving the resource in the stream.
	 */
	void save(OutputStream stream) throws Exception;

}