Skip to content

Commit 8866fa6

Browse files
philwebbrwinch
philwebb
authored and
rwinch
committed
Always use 'this.' when accessing fields
Apply an Eclipse cleanup rules to ensure that fields are always accessed using `this.`. This aligns with the style used by Spring Framework and helps users quickly see the difference between a local and member variable. Issue gh-8945
1 parent 6894ff5 commit 8866fa6

File tree

793 files changed

+8706
-8476
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

793 files changed

+8706
-8476
lines changed

‎acl/src/main/java/org/springframework/security/acls/AclEntryVoter.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -135,15 +135,15 @@ public AclEntryVoter(AclService aclService, String processConfigAttribute, Permi
135135
* which will be the domain object used for ACL evaluation
136136
*/
137137
protected String getInternalMethod() {
138-
return internalMethod;
138+
return this.internalMethod;
139139
}
140140

141141
public void setInternalMethod(String internalMethod) {
142142
this.internalMethod = internalMethod;
143143
}
144144

145145
protected String getProcessConfigAttribute() {
146-
return processConfigAttribute;
146+
return this.processConfigAttribute;
147147
}
148148

149149
public void setObjectIdentityRetrievalStrategy(ObjectIdentityRetrievalStrategy objectIdentityRetrievalStrategy) {
@@ -181,41 +181,41 @@ public int vote(Authentication authentication, MethodInvocation object, Collecti
181181
}
182182

183183
// Evaluate if we are required to use an inner domain object
184-
if (StringUtils.hasText(internalMethod)) {
184+
if (StringUtils.hasText(this.internalMethod)) {
185185
try {
186186
Class<?> clazz = domainObject.getClass();
187-
Method method = clazz.getMethod(internalMethod, new Class[0]);
187+
Method method = clazz.getMethod(this.internalMethod, new Class[0]);
188188
domainObject = method.invoke(domainObject);
189189
}
190190
catch (NoSuchMethodException nsme) {
191191
throw new AuthorizationServiceException("Object of class '" + domainObject.getClass()
192-
+ "' does not provide the requested internalMethod: " + internalMethod);
192+
+ "' does not provide the requested internalMethod: " + this.internalMethod);
193193
}
194194
catch (IllegalAccessException iae) {
195195
logger.debug("IllegalAccessException", iae);
196196

197197
throw new AuthorizationServiceException(
198-
"Problem invoking internalMethod: " + internalMethod + " for object: " + domainObject);
198+
"Problem invoking internalMethod: " + this.internalMethod + " for object: " + domainObject);
199199
}
200200
catch (InvocationTargetException ite) {
201201
logger.debug("InvocationTargetException", ite);
202202

203203
throw new AuthorizationServiceException(
204-
"Problem invoking internalMethod: " + internalMethod + " for object: " + domainObject);
204+
"Problem invoking internalMethod: " + this.internalMethod + " for object: " + domainObject);
205205
}
206206
}
207207

208208
// Obtain the OID applicable to the domain object
209-
ObjectIdentity objectIdentity = objectIdentityRetrievalStrategy.getObjectIdentity(domainObject);
209+
ObjectIdentity objectIdentity = this.objectIdentityRetrievalStrategy.getObjectIdentity(domainObject);
210210

211211
// Obtain the SIDs applicable to the principal
212-
List<Sid> sids = sidRetrievalStrategy.getSids(authentication);
212+
List<Sid> sids = this.sidRetrievalStrategy.getSids(authentication);
213213

214214
Acl acl;
215215

216216
try {
217217
// Lookup only ACLs for SIDs we're interested in
218-
acl = aclService.readAclById(objectIdentity, sids);
218+
acl = this.aclService.readAclById(objectIdentity, sids);
219219
}
220220
catch (NotFoundException nfe) {
221221
if (logger.isDebugEnabled()) {
@@ -226,7 +226,7 @@ public int vote(Authentication authentication, MethodInvocation object, Collecti
226226
}
227227

228228
try {
229-
if (acl.isGranted(requirePermission, sids, false)) {
229+
if (acl.isGranted(this.requirePermission, sids, false)) {
230230
if (logger.isDebugEnabled()) {
231231
logger.debug("Voting to grant access");
232232
}

‎acl/src/main/java/org/springframework/security/acls/AclPermissionCacheOptimizer.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,17 +63,17 @@ public void cachePermissionsFor(Authentication authentication, Collection<?> obj
6363
if (domainObject == null) {
6464
continue;
6565
}
66-
ObjectIdentity oid = oidRetrievalStrategy.getObjectIdentity(domainObject);
66+
ObjectIdentity oid = this.oidRetrievalStrategy.getObjectIdentity(domainObject);
6767
oidsToCache.add(oid);
6868
}
6969

70-
List<Sid> sids = sidRetrievalStrategy.getSids(authentication);
70+
List<Sid> sids = this.sidRetrievalStrategy.getSids(authentication);
7171

72-
if (logger.isDebugEnabled()) {
73-
logger.debug("Eagerly loading Acls for " + oidsToCache.size() + " objects");
72+
if (this.logger.isDebugEnabled()) {
73+
this.logger.debug("Eagerly loading Acls for " + oidsToCache.size() + " objects");
7474
}
7575

76-
aclService.readAclsById(oidsToCache, sids);
76+
this.aclService.readAclsById(oidsToCache, sids);
7777
}
7878

7979
public void setObjectIdentityRetrievalStrategy(ObjectIdentityRetrievalStrategy objectIdentityRetrievalStrategy) {

‎acl/src/main/java/org/springframework/security/acls/AclPermissionEvaluator.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -75,49 +75,49 @@ public boolean hasPermission(Authentication authentication, Object domainObject,
7575
return false;
7676
}
7777

78-
ObjectIdentity objectIdentity = objectIdentityRetrievalStrategy.getObjectIdentity(domainObject);
78+
ObjectIdentity objectIdentity = this.objectIdentityRetrievalStrategy.getObjectIdentity(domainObject);
7979

8080
return checkPermission(authentication, objectIdentity, permission);
8181
}
8282

8383
public boolean hasPermission(Authentication authentication, Serializable targetId, String targetType,
8484
Object permission) {
85-
ObjectIdentity objectIdentity = objectIdentityGenerator.createObjectIdentity(targetId, targetType);
85+
ObjectIdentity objectIdentity = this.objectIdentityGenerator.createObjectIdentity(targetId, targetType);
8686

8787
return checkPermission(authentication, objectIdentity, permission);
8888
}
8989

9090
private boolean checkPermission(Authentication authentication, ObjectIdentity oid, Object permission) {
9191
// Obtain the SIDs applicable to the principal
92-
List<Sid> sids = sidRetrievalStrategy.getSids(authentication);
92+
List<Sid> sids = this.sidRetrievalStrategy.getSids(authentication);
9393
List<Permission> requiredPermission = resolvePermission(permission);
9494

95-
final boolean debug = logger.isDebugEnabled();
95+
final boolean debug = this.logger.isDebugEnabled();
9696

9797
if (debug) {
98-
logger.debug("Checking permission '" + permission + "' for object '" + oid + "'");
98+
this.logger.debug("Checking permission '" + permission + "' for object '" + oid + "'");
9999
}
100100

101101
try {
102102
// Lookup only ACLs for SIDs we're interested in
103-
Acl acl = aclService.readAclById(oid, sids);
103+
Acl acl = this.aclService.readAclById(oid, sids);
104104

105105
if (acl.isGranted(requiredPermission, sids, false)) {
106106
if (debug) {
107-
logger.debug("Access is granted");
107+
this.logger.debug("Access is granted");
108108
}
109109

110110
return true;
111111
}
112112

113113
if (debug) {
114-
logger.debug("Returning false - ACLs returned, but insufficient permissions for this principal");
114+
this.logger.debug("Returning false - ACLs returned, but insufficient permissions for this principal");
115115
}
116116

117117
}
118118
catch (NotFoundException nfe) {
119119
if (debug) {
120-
logger.debug("Returning false - no ACLs apply for this principal");
120+
this.logger.debug("Returning false - no ACLs apply for this principal");
121121
}
122122
}
123123

@@ -127,7 +127,7 @@ private boolean checkPermission(Authentication authentication, ObjectIdentity oi
127127

128128
List<Permission> resolvePermission(Object permission) {
129129
if (permission instanceof Integer) {
130-
return Arrays.asList(permissionFactory.buildFromMask((Integer) permission));
130+
return Arrays.asList(this.permissionFactory.buildFromMask((Integer) permission));
131131
}
132132

133133
if (permission instanceof Permission) {
@@ -143,10 +143,10 @@ List<Permission> resolvePermission(Object permission) {
143143
Permission p;
144144

145145
try {
146-
p = permissionFactory.buildFromName(permString);
146+
p = this.permissionFactory.buildFromName(permString);
147147
}
148148
catch (IllegalArgumentException notfound) {
149-
p = permissionFactory.buildFromName(permString.toUpperCase(Locale.ENGLISH));
149+
p = this.permissionFactory.buildFromName(permString.toUpperCase(Locale.ENGLISH));
150150
}
151151

152152
if (p != null) {

‎acl/src/main/java/org/springframework/security/acls/afterinvocation/AbstractAclProvider.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,21 +68,21 @@ public AbstractAclProvider(AclService aclService, String processConfigAttribute,
6868
}
6969

7070
protected Class<?> getProcessDomainObjectClass() {
71-
return processDomainObjectClass;
71+
return this.processDomainObjectClass;
7272
}
7373

7474
protected boolean hasPermission(Authentication authentication, Object domainObject) {
7575
// Obtain the OID applicable to the domain object
76-
ObjectIdentity objectIdentity = objectIdentityRetrievalStrategy.getObjectIdentity(domainObject);
76+
ObjectIdentity objectIdentity = this.objectIdentityRetrievalStrategy.getObjectIdentity(domainObject);
7777

7878
// Obtain the SIDs applicable to the principal
79-
List<Sid> sids = sidRetrievalStrategy.getSids(authentication);
79+
List<Sid> sids = this.sidRetrievalStrategy.getSids(authentication);
8080

8181
try {
8282
// Lookup only ACLs for SIDs we're interested in
83-
Acl acl = aclService.readAclById(objectIdentity, sids);
83+
Acl acl = this.aclService.readAclById(objectIdentity, sids);
8484

85-
return acl.isGranted(requirePermission, sids, false);
85+
return acl.isGranted(this.requirePermission, sids, false);
8686
}
8787
catch (NotFoundException ignore) {
8888
return false;
@@ -110,7 +110,7 @@ public void setSidRetrievalStrategy(SidRetrievalStrategy sidRetrievalStrategy) {
110110
}
111111

112112
public boolean supports(ConfigAttribute attribute) {
113-
return processConfigAttribute.equals(attribute.getAttribute());
113+
return this.processConfigAttribute.equals(attribute.getAttribute());
114114
}
115115

116116
/**

‎acl/src/main/java/org/springframework/security/acls/afterinvocation/AclEntryAfterInvocationProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public Object decide(Authentication authentication, Object object, Collection<Co
103103

104104
logger.debug("Denying access");
105105

106-
throw new AccessDeniedException(messages.getMessage("AclEntryAfterInvocationProvider.noPermission",
106+
throw new AccessDeniedException(this.messages.getMessage("AclEntryAfterInvocationProvider.noPermission",
107107
new Object[] { authentication.getName(), returnedObject },
108108
"Authentication {0} has NO permissions to the domain object {1}"));
109109
}

‎acl/src/main/java/org/springframework/security/acls/afterinvocation/ArrayFilterer.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ class ArrayFilterer<T> implements Filterer<T> {
4545
// Collect the removed objects to a HashSet so that
4646
// it is fast to lookup them when a filtered array
4747
// is constructed.
48-
removeList = new HashSet<>();
48+
this.removeList = new HashSet<>();
4949
}
5050

5151
/**
@@ -55,14 +55,14 @@ class ArrayFilterer<T> implements Filterer<T> {
5555
@SuppressWarnings("unchecked")
5656
public T[] getFilteredObject() {
5757
// Recreate an array of same type and filter the removed objects.
58-
int originalSize = list.length;
59-
int sizeOfResultingList = originalSize - removeList.size();
60-
T[] filtered = (T[]) Array.newInstance(list.getClass().getComponentType(), sizeOfResultingList);
58+
int originalSize = this.list.length;
59+
int sizeOfResultingList = originalSize - this.removeList.size();
60+
T[] filtered = (T[]) Array.newInstance(this.list.getClass().getComponentType(), sizeOfResultingList);
6161

62-
for (int i = 0, j = 0; i < list.length; i++) {
63-
T object = list[i];
62+
for (int i = 0, j = 0; i < this.list.length; i++) {
63+
T object = this.list[i];
6464

65-
if (!removeList.contains(object)) {
65+
if (!this.removeList.contains(object)) {
6666
filtered[j] = object;
6767
j++;
6868
}
@@ -85,14 +85,14 @@ public Iterator<T> iterator() {
8585
private int index = 0;
8686

8787
public boolean hasNext() {
88-
return index < list.length;
88+
return this.index < ArrayFilterer.this.list.length;
8989
}
9090

9191
public T next() {
9292
if (!hasNext()) {
9393
throw new NoSuchElementException();
9494
}
95-
return list[index++];
95+
return ArrayFilterer.this.list[this.index++];
9696
}
9797

9898
public void remove() {
@@ -106,7 +106,7 @@ public void remove() {
106106
* @see org.springframework.security.acls.afterinvocation.Filterer#remove(java.lang.Object)
107107
*/
108108
public void remove(T object) {
109-
removeList.add(object);
109+
this.removeList.add(object);
110110
}
111111

112112
}

‎acl/src/main/java/org/springframework/security/acls/afterinvocation/CollectionFilterer.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class CollectionFilterer<T> implements Filterer<T> {
4848
// to the method may not necessarily be re-constructable (as
4949
// the Collection(collection) constructor is not guaranteed and
5050
// manually adding may lose sort order or other capabilities)
51-
removeList = new HashSet<>();
51+
this.removeList = new HashSet<>();
5252
}
5353

5454
/**
@@ -57,36 +57,36 @@ class CollectionFilterer<T> implements Filterer<T> {
5757
*/
5858
public Object getFilteredObject() {
5959
// Now the Iterator has ended, remove Objects from Collection
60-
Iterator<T> removeIter = removeList.iterator();
60+
Iterator<T> removeIter = this.removeList.iterator();
6161

62-
int originalSize = collection.size();
62+
int originalSize = this.collection.size();
6363

6464
while (removeIter.hasNext()) {
65-
collection.remove(removeIter.next());
65+
this.collection.remove(removeIter.next());
6666
}
6767

6868
if (logger.isDebugEnabled()) {
6969
logger.debug("Original collection contained " + originalSize + " elements; now contains "
70-
+ collection.size() + " elements");
70+
+ this.collection.size() + " elements");
7171
}
7272

73-
return collection;
73+
return this.collection;
7474
}
7575

7676
/**
7777
*
7878
* @see org.springframework.security.acls.afterinvocation.Filterer#iterator()
7979
*/
8080
public Iterator<T> iterator() {
81-
return collection.iterator();
81+
return this.collection.iterator();
8282
}
8383

8484
/**
8585
*
8686
* @see org.springframework.security.acls.afterinvocation.Filterer#remove(java.lang.Object)
8787
*/
8888
public void remove(T object) {
89-
removeList.add(object);
89+
this.removeList.add(object);
9090
}
9191

9292
}

‎acl/src/main/java/org/springframework/security/acls/domain/AbstractPermission.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,15 @@ public final boolean equals(Object arg0) {
6565
}
6666

6767
public final int getMask() {
68-
return mask;
68+
return this.mask;
6969
}
7070

7171
public String getPattern() {
72-
return AclFormattingUtils.printBinary(mask, code);
72+
return AclFormattingUtils.printBinary(this.mask, this.code);
7373
}
7474

7575
public final String toString() {
76-
return this.getClass().getSimpleName() + "[" + getPattern() + "=" + mask + "]";
76+
return this.getClass().getSimpleName() + "[" + getPattern() + "=" + this.mask + "]";
7777
}
7878

7979
public final int hashCode() {

‎acl/src/main/java/org/springframework/security/acls/domain/AccessControlEntryImpl.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -134,37 +134,37 @@ public int hashCode() {
134134

135135
@Override
136136
public Acl getAcl() {
137-
return acl;
137+
return this.acl;
138138
}
139139

140140
@Override
141141
public Serializable getId() {
142-
return id;
142+
return this.id;
143143
}
144144

145145
@Override
146146
public Permission getPermission() {
147-
return permission;
147+
return this.permission;
148148
}
149149

150150
@Override
151151
public Sid getSid() {
152-
return sid;
152+
return this.sid;
153153
}
154154

155155
@Override
156156
public boolean isAuditFailure() {
157-
return auditFailure;
157+
return this.auditFailure;
158158
}
159159

160160
@Override
161161
public boolean isAuditSuccess() {
162-
return auditSuccess;
162+
return this.auditSuccess;
163163
}
164164

165165
@Override
166166
public boolean isGranting() {
167-
return granting;
167+
return this.granting;
168168
}
169169

170170
void setAuditFailure(boolean auditFailure) {

0 commit comments

Comments
 (0)