org.gradle.tooling.model.eclipse.EclipseLinkedResource Maven / Gradle / Ivy
Show all versions of gradle-api Show documentation
/*
* Copyright 2011 the original author or authors.
*
* Licensed 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.gradle.tooling.model.eclipse;
/**
* Linked resources are files and folders that are stored in locations in the file system outside of the project's location.
*
* @since 1.0-milestone-4
*/
public interface EclipseLinkedResource {
/**
* The project-relative path of the linked resource as it appears in the workspace.
*
* See the official Eclipse documentation for most up-to-date information on properties of a linked resource
*
* For example, a linked resource to a file system folder /some/path/to/someFolder can have a name 'someFolder'
*
* @return name
*/
String getName();
/**
* The resource type.
*
* If 'location' property is used the values are: "1" for a file, or "2" for a folder.
*
* If 'locationUri' property is used then the values are:
* "1" for file or folder when 'locationUri' first segment is a workspace path variable (or path variable navigation element),
* "2" for an eclipse virtual folder.
*
* See the official Eclipse documentation for most up-to-date information on properties of a linked resource
*
* @return Eclipse link type
*/
String getType();
/**
* The local file system absolute path of the target of the linked resource. For example: '/path/to/somewhere'.
* Mutually exclusive with 'locationUri'
*
* See the official Eclipse documentation for most up-to-date information on properties of a linked resource
*
* @return location
*/
String getLocation();
/**
* If the file is not in the local file system, this attribute contains the absolute URI of the resource in some backing file system.
* Mutually exclusive with 'location'.
*
* When workspace path variable is used as part of path then this property must be used instead of 'location'
*
* Used for virtual folders. In that case the value is: 'virtual:/virtual'
*
* See the official Eclipse documentation for most up-to-date information on properties of a linked resource
*
* @return location uri
*/
String getLocationUri();
}