webcommon/javascript2.jsdoc/src/org/netbeans/modules/javascript2/jsdoc/model/AssignElement.java

/*
 * 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.modules.javascript2.jsdoc.model;

/**
 * Represents jsDoc elements which assigns foreign member field.
 * <p>
 * <i>Examples:</i> @borrows otherMemberName as thisMemberName
 *
 * @author Martin Fousek <marfous@netbeans.org>
 */
public class AssignElement extends JsDocElementImpl {

    private final NamePath otherMemberName;
    private final NamePath thisMemberName;

    private AssignElement(JsDocElementType type, NamePath otherMemberName, NamePath thisMemberName) {
        super(type);
        this.otherMemberName = otherMemberName;
        this.thisMemberName = thisMemberName;
    }

    public static AssignElement create(JsDocElementType type, NamePath otherMemberName, NamePath thisMemberName) {
        return new AssignElement(type, otherMemberName, thisMemberName);
    }

    /**
     * Gets other member name path.
     * @return other member name path
     */
    public NamePath getOtherMemberName() {
        return otherMemberName;
    }

    /**
     * Gets this member name path.
     * @return this member name path
     */
    public NamePath getThisMemberName() {
        return thisMemberName;
    }

}