001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.loggers;
028    
029    import java.io.File;
030    import java.io.FilenameFilter;
031    
032    /**
033     * A FileNamingPolicy is used by a MultiFileWriter to generate the
034     * sequence of file names to use when writing.
035     */
036    public interface FileNamingPolicy
037    {
038      /**
039       * Initializes the policy and returns the current name to use.
040       *
041       * @return the initial file.
042       */
043      public File getInitialName();
044    
045      /**
046       * Gets the next name to use.
047       *
048       * @return the next file.
049       */
050      public File getNextName();
051    
052      /**
053       * Gets the filename filter that can be used to filter files named by this
054       * policy.
055       *
056       * @return The FilenameFilter that can filter files named by this policy.
057       */
058      public FilenameFilter getFilenameFilter();
059    
060      /**
061       * Gets all the existing files named by this policy.
062       *
063       * @return The files named by this policy or <code>null</code> if an
064       *         error occured.
065       */
066      public File[] listFiles();
067    
068    
069    }