/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.api.editor.document;

import java.util.EventObject;
import javax.swing.text.Document;

/**
 * Event for atomic lock listener notifications.
 */
public class AtomicLockEvent extends EventObject {

    /*
     * Construct new AtomicLockEvent.
     * @param source  the Object that is the source of the event
     */
    public AtomicLockEvent(Document source) {
        super(source);
    }
    
    /**
     * Returns the source Document. Convenience method, equivalent to
     * {@link #getSource} but with the proper type.
     * @return the Document instance
     */
    public Document getDocument() {
        return (Document)super.getSource();
    }

    /**
     * Convenience method to return the atomic lock for the source document
     * @return the atomic lock
     */
    public AtomicLockDocument getAtomicLock() {
        return LineDocumentUtils.as(getDocument(), AtomicLockDocument.class);
    }
}
