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
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.spi.project.support.ant;
043:
044: import java.util.EventObject;
045:
046: /**
047: * Event object corresponding to a change made in an Ant project's metadata.
048: * The event source is an {@link AntProjectHelper}.
049: * @see AntProjectListener
050: * @author Jesse Glick
051: */
052: public final class AntProjectEvent extends EventObject {
053:
054: private final String path;
055: private final boolean expected;
056:
057: AntProjectEvent(AntProjectHelper helper, String path,
058: boolean expected) {
059: super (helper);
060: this .path = path;
061: this .expected = expected;
062: }
063:
064: /**
065: * Get the associated Ant project helper object.
066: * @return the project helper which fired the event
067: */
068: public AntProjectHelper getHelper() {
069: return (AntProjectHelper) getSource();
070: }
071:
072: /**
073: * Get the path to the modified (or created or deleted) file.
074: * Paths typically used are:
075: * <ol>
076: * <li>{@link AntProjectHelper#PROJECT_PROPERTIES_PATH}
077: * <li>{@link AntProjectHelper#PRIVATE_PROPERTIES_PATH}
078: * <li>{@link AntProjectHelper#PROJECT_XML_PATH}
079: * <li>{@link AntProjectHelper#PRIVATE_XML_PATH}
080: * </ol>
081: * However for properties files, other paths may exist if the project
082: * uses them for some purpose.
083: * @return a project-relative path
084: */
085: public String getPath() {
086: return path;
087: }
088:
089: /**
090: * Check whether the change was produced by calling methods on
091: * {@link AntProjectHelper} or whether it represents a change
092: * detected on disk.
093: * @return true if the change was triggered by in-memory modification methods,
094: * false if occurred on disk in the metadata files and is being loaded
095: */
096: public boolean isExpected() {
097: return expected;
098: }
099:
100: }
|