001/**
002 * Java Web Archive Toolkit - Software to read and validate ARC, WARC
003 * and GZip files. (http://jwat.org/)
004 * Copyright 2011-2012 Netarkivet.dk (http://netarkivet.dk/)
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.jwat.warc;
019
020/**
021 * Implementations of this interface are used to name the WARC files written by the <code>WarcFileWriter</code>.
022 *
023 * @author nicl
024 */
025public interface WarcFileNaming {
026
027    /**
028     * Does this naming implementation support multiple files.
029     * @return boolean indicating support for multiple files
030     */
031    public boolean supportMultipleFiles();
032
033    /**
034     * Return the next file name to use.
035     * @param sequenceNr sequence number to use
036     * @param bCompressed is the file compressed or not
037     * @return the next file name to use
038     */
039    public String getFilename(int sequenceNr, boolean bCompressed);
040
041}