blob: 5443ae7e690a803dbeab3180318757c64c57b8c0 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
/*****************************************************************************
* Copyright (c) 2011, 2013 Atos Origin, CEA, 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
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Mathieu Velten (Atos Origin) mathieu.velten@atosorigin.com - Initial API and implementation
* Christian W. Damus (CEA)
*
*****************************************************************************/
package org.eclipse.papyrus.infra.core.resource;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.edit.domain.EditingDomain;
import com.google.common.base.Optional;
public interface IReadOnlyHandler {
/**
* Queries whether any of the resources identified by the given URIs is
* read-only.
*
* @param uris
* the URIs about which read-only-ness is to be determined
* @param editingDomain
* the domain in the context of which editing is being done
*
* @return {@link Optional#absent() absent} if I do not know whether any of
* the URIs is read-only or a {@link Optional#isPresent() present}
* boolean indicating whether any definitively is or they all
* definitively are not read-only
*/
Optional<Boolean> anyReadOnly(URI[] uris);
/**
* Attempt to ensure that the resources identified by the given URIs are
* writable.
*
* @param uris
* the URIs of resources to make writable (not all are
* necessarily read-only)
* @param editingDomain
* the domain in the context of which editing is being done
*
* @return {@link Optional#absent() absent} if I do not know how to make
* these resources writable and the next provider should be given a
* chance, or a {@link Optional#isPresent() present} boolean
* indicating that I made the resources writable ({@code true}) or
* they cannot be made writable ({@code false})
*/
Optional<Boolean> makeWritable(URI[] uris);
/**
* Queries whether an {@code eObject} is individually read-only in a given
* editing domain, if it is in a resource that supports object-level
* read/write permissions.
*
* @param eObject
* an element in some model resource
* @param editingDomain
* the contextual editing domain
*
* @return {@link Optional#absent() absent} if I do not know whether the
* {@code eObject} is read-only or a {@link Optional#isPresent()
* present} boolean indicating whether it definitively is or is not
* read-only
*/
Optional<Boolean> isReadOnly(EObject eObject);
/**
* Attempt to ensure that the given {@code eObject} is writable.
*
* @param eObject
* a {@linkplain #isReadOnly(EObject, EditingDomain) read-only}
* element in some model resource
* @param editingDomain
* the domain in the context of which editing is being done
*
* @return {@link Optional#absent() absent} if I do not know how to make
* this object writable and the next provider should be given a
* chance, or a {@link Optional#isPresent() present} boolean
* indicating that I made it writable ({@code true}) or it cannot be
* made writable ({@code false})
*/
Optional<Boolean> makeWritable(EObject eObject);
}
|
