001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU General
007: * Public License Version 2 only ("GPL") or the Common Development and Distribution
008: * License("CDDL") (collectively, the "License"). You may not use this file except in
009: * compliance with the License. You can obtain a copy of the License at
010: * http://www.netbeans.org/cddl-gplv2.html or nbbuild/licenses/CDDL-GPL-2-CP. See the
011: * License for the specific language governing permissions and limitations under the
012: * License. When distributing the software, include this License Header Notice in
013: * each file and include the License file at nbbuild/licenses/CDDL-GPL-2-CP. Sun
014: * designates this particular file as subject to the "Classpath" exception as
015: * provided by Sun in the GPL Version 2 section of the License file that
016: * accompanied this code. If applicable, add the following below the License Header,
017: * with the fields enclosed by brackets [] replaced by your own identifying
018: * information: "Portions Copyrighted [year] [name of copyright owner]"
019: *
020: * Contributor(s):
021: *
022: * The Original Software is NetBeans. The Initial Developer of the Original Software
023: * is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun Microsystems, Inc. All
024: * Rights Reserved.
025: *
026: * If you wish your version of this file to be governed by only the CDDL or only the
027: * GPL Version 2, indicate your decision by adding "[Contributor] elects to include
028: * this software in this distribution under the [CDDL or GPL Version 2] license." If
029: * you do not indicate a single choice of license, a recipient has the option to
030: * distribute your version of this file under either the CDDL, the GPL Version 2 or
031: * to extend the choice of license to its licensees as provided above. However, if
032: * you add GPL Version 2 code and therefore, elected the GPL Version 2 license, then
033: * the option applies only if the new code is made subject to such option by the
034: * copyright holder.
035: */
036:
037: package org.netbeans.installer.infra.utils.comment.handlers;
038:
039: import java.io.File;
040: import java.io.IOException;
041:
042: /**
043: * The interface that all file handlers, i.e. classes handling comment correction
044: * for concrete file types, should implement.
045: *
046: * <p>
047: * It requires the implementing classes to provide functionality of loading/saving a
048: * file, extracting the current initial comment, iserting a new one and updating
049: * (replacing) the current.
050: *
051: * @author Kirill Sorokin
052: */
053: public interface FileHandler {
054: /**
055: * Checks whether the given ile can be processed by this file handler.
056: *
057: * @param file The file for which to run the compatibility check.
058: * @return <code>true</code> if the current file handler is capable of handling
059: * the file, <code>false</code> otherwise.
060: */
061: boolean accept(final File file);
062:
063: /**
064: * Loads the file into file handler's cache.
065: *
066: * @param file The file to load.
067: * @throws java.io.IOException if an I/O error occurs.
068: * @throws java.lang.IllegalArgumentException if the parameter validation fails.
069: */
070: void load(final File file) throws IOException;
071:
072: /**
073: * Saves the cached file contents to the given file on disk.
074: *
075: * @param file The file to which the cache should be saved.
076: * @throws java.io.IOException if an I/O error occurs.
077: * @throws java.lang.IllegalArgumentException if the parameter validation fails.
078: * @throws java.lang.IllegalStateException if the file contents cache
079: * is <code>null</code>.
080: */
081: void save(final File file) throws IOException;
082:
083: /**
084: * Extracts the current initial comment from the cached file contents.
085: *
086: * @return Teh current initial comment or <code>null</code> if the initial
087: * comment does not exist.
088: * @throws java.lang.IllegalStateException if the file handler does not have
089: * anything loaded.
090: */
091: String getCurrentComment();
092:
093: /**
094: * Constructs the correct initial comment.
095: *
096: * @param text The text of the initial comment.
097: * @param lineLength The desired line length for the comment.
098: * @return The correct, formatted, initial comment for this type of file.
099: */
100: String getCorrectComment(final String text, final int lineLength);
101:
102: /**
103: * Inserts the initial comment to the cached file contents. If an intiial
104: * comment already exists in the file it is prepended by the new one.
105: *
106: * @param text The text of the new initial comment.
107: * @param lineLength The desired line length for the comment.
108: * @throws java.lang.IllegalArgumentException if the parameters validation
109: * fails.
110: * @throws java.lang.IllegalStateException if the file handler does not have
111: * anything loaded.
112: */
113: void insertComment(final String text, final int lineLength);
114:
115: /**
116: * Updates the current initial comment in the cached file contents. If there is
117: * no initia comment, then this method falls back to
118: * {@link #insertComment(String, int)}.
119: *
120: * @param text The text of the new initial comment.
121: * @param lineLength The desired line length for the comment.
122: * @throws java.lang.IllegalArgumentException if the parameters validation
123: * fails.
124: * @throws java.lang.IllegalStateException if the file handler does not have
125: * anything loaded.
126: */
127: void updateComment(final String text, final int lineLength);
128: }
|