blob: 8a62dc7b3c59497c9483af386c599117d6432af6 (
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/*******************************************************************************
* Copyright (c) 2008, 2012 Oracle. 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:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.jpa.core;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.jpt.common.core.JptResourceType;
import org.eclipse.jpt.common.core.utility.TextRange;
import org.eclipse.jpt.common.utility.internal.StringTools;
import org.eclipse.jpt.common.utility.model.Model;
/**
* Interface implemented by any object to appear in the JPA Structure view
* and JPA Details View. This interface is also used by the JPA Selection
* Managers.
* <p>
* Provisional API: This interface is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*
* @version 2.3
* @since 2.0
*/
public interface JpaStructureNode
extends Model, IAdaptable
{
/**
* Return the structure node at the specified offset in the structure node's
* corresponding text file.
*/
JpaStructureNode getStructureNode(int textOffset);
/**
* Return the text range to be used to select text in the editor
* corresponding to the structure node.
*/
TextRange getSelectionTextRange();
/**
* Return the structure node's context type.
* Type used to identify a JPA structure node's type with respect to the
* structure node's context
* (i.e. its type in the scope of the JPA platform that created the
* structure node and the structure node's resource).
*
* @see #getJpaPlatform()
* @see #getResourceType()
* @see #getType()
*/
ContextType getContextType();
/**
* Return the structure node's JPA platform.
* This is used to find the appropriate UI platform for building the
* structure node's JPA Details Page.
*/
JpaPlatform getJpaPlatform();
/**
* Return the structure node's resource type.
* This is used to find the appropriate UI provider for building the
* structure node's JPA Details Page.
*/
JptResourceType getResourceType();
/**
* Return the structure node's type.
* This is used to find the appropriate UI provider for building the
* structure node's JPA Details Page.
*/
Class<? extends JpaStructureNode> getType();
/**
* Dispose the structure node and its children.
* Typically this would be used to update the structure node's
* JPA file's root structure nodes.
*/
void dispose();
/**
* Type used to identify a JPA structure node's type with respect to the
* structure node's context
* (i.e. its type in the scope of the JPA platform that created the
* structure node and the structure node's resource).
*/
final class ContextType {
private final JpaStructureNode node;
public ContextType(JpaStructureNode node) {
super();
if (node == null) {
throw new NullPointerException();
}
this.node = node;
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if ((obj == null) || (obj.getClass() != this.getClass())) {
return false;
}
ContextType other = (ContextType) obj;
return this.node.getJpaPlatform().equals(other.node.getJpaPlatform()) &&
this.node.getResourceType().equals(other.node.getResourceType()) &&
this.node.getType().equals(other.node.getType());
}
@Override
public int hashCode() {
final int prime = 31;
int hash = 17;
hash = hash * prime + this.node.getJpaPlatform().hashCode();
hash = hash * prime + this.node.getResourceType().hashCode();
hash = hash * prime + this.node.getType().hashCode();
return hash;
}
@Override
public String toString() {
return StringTools.buildToStringFor(this, this.node);
}
}
}
|
