/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2015, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.as.cli.operation;

import java.util.Collection;
import java.util.List;
import java.util.Set;

import org.jboss.as.cli.CommandLineFormat;
import org.jboss.as.cli.parsing.StateParser.SubstitutedLine;


/**
*
* @author Alexey Loubyansky
*/
public interface ParsedCommandLine {

    String getOriginalLine();

    /**
     * The original line with all the necessary substitution
     * (of commands, variables, system properties, etc) performed.
     * @return  the original line with all the necessary substitution
     * (of commands, variables, system properties, etc) performed
     */
    String getSubstitutedLine();

    SubstitutedLine getSubstitutions();

    boolean isRequestComplete();

    boolean endsOnPropertySeparator();

    boolean endsOnPropertyValueSeparator();

    boolean endsOnPropertyListStart();

    boolean endsOnPropertyListEnd();

    boolean endsOnNotOperator();

    boolean isLastPropertyNegated();

    boolean endsOnAddressOperationNameSeparator();

    boolean endsOnNodeSeparator();

    boolean endsOnNodeTypeNameSeparator();

    boolean endsOnSeparator();

    boolean hasAddress();

    OperationRequestAddress getAddress();

    boolean hasOperationName();

    String getOperationName();

    boolean hasProperties();

    boolean hasProperty(String propertyName);

    Set<String> getPropertyNames();

    String getPropertyValue(String name);

    List<String> getOtherProperties();

    boolean endsOnHeaderListStart();

    boolean endsOnHeaderSeparator();

    int getLastSeparatorIndex();

    int getLastChunkIndex();

    int getLastSeparatorOriginalIndex();

    int getLastChunkOriginalIndex();

    int getOriginalOffset(int offset);

    String getLastParsedPropertyName();

    String getLastParsedPropertyValue();

    String getOutputTarget();

    boolean hasHeaders();

    boolean hasHeader(String header);

    Collection<ParsedOperationRequestHeader> getHeaders();

    String getLastHeaderName();

    ParsedOperationRequestHeader getLastHeader();

    CommandLineFormat getFormat();

    boolean hasOperator();
}
