    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.collections4.sequence;
    018
    019/**
    020 * Command representing the insertion of one object of the second sequence.
    021 * <p>
    022 * When one object of the second sequence has no corresponding object in the
    023 * first sequence at the right place, the {@link EditScript edit script}
    024 * transforming the first sequence into the second sequence uses an instance of
    025 * this class to represent the insertion of this object. The objects embedded in
    026 * these type of commands always come from the second sequence.
    027 *
    028 * @see SequencesComparator
    029 * @see EditScript
    030 *
    031 * @since 4.0
    032 */
    033public class InsertCommand<T> extends EditCommand<T> {
    034
    035    /**
    036     * Simple constructor. Creates a new instance of InsertCommand
    037     *
    038     * @param object  the object of the second sequence that should be inserted
    039     */
    040    public InsertCommand(final T object) {
    041        super(object);
    042    }
    043
    044    /**
    045     * Accept a visitor. When an <code>InsertCommand</code> accepts a visitor,
    046     * it calls its {@link CommandVisitor#visitInsertCommand visitInsertCommand}
    047     * method.
    048     *
    049     * @param visitor  the visitor to be accepted
    050     */
    051    @Override
    052    public void accept(final CommandVisitor<T> visitor) {
    053        visitor.visitInsertCommand(getObject());
    054    }
    055
    056}