blob: 0cd6568ef6bf26874a04a1e5eef6f89d54222c93 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2009, 2019 Xored Software Inc and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* Xored Software Inc - initial API and implementation and/or initial documentation
*******************************************************************************/
package org.eclipse.rcptt.ecl.data.commands;
import org.eclipse.rcptt.ecl.core.Command;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Read File</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.rcptt.ecl.data.commands.ReadFile#getUri <em>Uri</em>}</li>
* </ul>
*
* @see org.eclipse.rcptt.ecl.data.commands.CommandsPackage#getReadFile()
* @model annotation="http://www.eclipse.org/ecl/docs description='Reads file identified by uri and writes it contents into output pipe' example='//Displays alert with file content\r\nshow-alert [read-file \"file:/path/to/your/file\"]\r\n\r\n\r\n\r\n'"
* @generated
*/
public interface ReadFile extends Command {
/**
* Returns the value of the '<em><b>Uri</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Uri</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Uri</em>' attribute.
* @see #setUri(String)
* @see org.eclipse.rcptt.ecl.data.commands.CommandsPackage#getReadFile_Uri()
* @model required="true"
* annotation="http://www.eclipse.org/ecl/docs description='URI to read file from. Currently supported schemes are workspace:/ for files in workspace and file:/ for files on local file system'"
* @generated
*/
String getUri();
/**
* Sets the value of the '{@link org.eclipse.rcptt.ecl.data.commands.ReadFile#getUri <em>Uri</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Uri</em>' attribute.
* @see #getUri()
* @generated
*/
void setUri(String value);
} // ReadFile