001/*
002 * Copyright 2023 the original author or authors.
003 * <p>
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * <p>
008 * https://www.apache.org/licenses/LICENSE-2.0
009 * <p>
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package de.cuioss.tools.io;
017
018import java.io.IOException;
019import java.io.OutputStream;
020import java.io.Serializable;
021
022/**
023 * Interface for file writer operations.
024 *
025 * @author Sven Haag
026 */
027public interface FileWriter extends Serializable {
028
029    /**
030     *
031     * @return true if an actual file is writable.
032     */
033    boolean isWritable();
034
035    /**
036     * @return the filename in an appropriate presentation.
037     */
038    StructuredFilename getFileName();
039
040    /**
041     * @return an {@link OutputStream} on the corresponding file. It implicitly
042     *         checks {@link #isWritable()} before accessing the file and will throw
043     *         an {@link IllegalStateException} in case it is not readable.
044     * @throws IOException
045     */
046    OutputStream outputStream() throws IOException;
047}