Skip to content

Commit 9e08b51

Browse files
philwebbrwinch
philwebb
authored and
rwinch
committed
Apply code cleanup rules to projects
Apply automated cleanup rules to add `@Override` and `@Deprecated` annotations and to fix class references used with static methods. Issue spring-projectsgh-8945
1 parent 8866fa6 commit 9e08b51

File tree

558 files changed

+1418
-102
lines changed

Some content is hidden

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

558 files changed

+1418
-102
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,10 +156,12 @@ public void setSidRetrievalStrategy(SidRetrievalStrategy sidRetrievalStrategy) {
156156
this.sidRetrievalStrategy = sidRetrievalStrategy;
157157
}
158158

159+
@Override
159160
public boolean supports(ConfigAttribute attribute) {
160161
return (attribute.getAttribute() != null) && attribute.getAttribute().equals(getProcessConfigAttribute());
161162
}
162163

164+
@Override
163165
public int vote(Authentication authentication, MethodInvocation object, Collection<ConfigAttribute> attributes) {
164166

165167
for (ConfigAttribute attr : attributes) {

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ public AclPermissionCacheOptimizer(AclService aclService) {
5252
this.aclService = aclService;
5353
}
5454

55+
@Override
5556
public void cachePermissionsFor(Authentication authentication, Collection<?> objects) {
5657
if (objects.isEmpty()) {
5758
return;

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ public AclPermissionEvaluator(AclService aclService) {
7070
* the ACL configuration. If the domain object is null, returns false (this can always
7171
* be overridden using a null check in the expression itself).
7272
*/
73+
@Override
7374
public boolean hasPermission(Authentication authentication, Object domainObject, Object permission) {
7475
if (domainObject == null) {
7576
return false;
@@ -80,6 +81,7 @@ public boolean hasPermission(Authentication authentication, Object domainObject,
8081
return checkPermission(authentication, objectIdentity, permission);
8182
}
8283

84+
@Override
8385
public boolean hasPermission(Authentication authentication, Serializable targetId, String targetType,
8486
Object permission) {
8587
ObjectIdentity objectIdentity = this.objectIdentityGenerator.createObjectIdentity(targetId, targetType);

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ public void setSidRetrievalStrategy(SidRetrievalStrategy sidRetrievalStrategy) {
109109
this.sidRetrievalStrategy = sidRetrievalStrategy;
110110
}
111111

112+
@Override
112113
public boolean supports(ConfigAttribute attribute) {
113114
return this.processConfigAttribute.equals(attribute.getAttribute());
114115
}
@@ -119,6 +120,7 @@ public boolean supports(ConfigAttribute attribute) {
119120
* @param clazz the secure object
120121
* @return always <code>true</code>
121122
*/
123+
@Override
122124
public boolean supports(Class<?> clazz) {
123125
return true;
124126
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ public AclEntryAfterInvocationCollectionFilteringProvider(AclService aclService,
7070
super(aclService, "AFTER_ACL_COLLECTION_READ", requirePermission);
7171
}
7272

73+
@Override
7374
@SuppressWarnings("unchecked")
7475
public Object decide(Authentication authentication, Object object, Collection<ConfigAttribute> config,
7576
Object returnedObject) throws AccessDeniedException {

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ public AclEntryAfterInvocationProvider(AclService aclService, String processConf
7474
super(aclService, processConfigAttribute, requirePermission);
7575
}
7676

77+
@Override
7778
public Object decide(Authentication authentication, Object object, Collection<ConfigAttribute> config,
7879
Object returnedObject) throws AccessDeniedException {
7980

@@ -111,6 +112,7 @@ public Object decide(Authentication authentication, Object object, Collection<Co
111112
return returnedObject;
112113
}
113114

115+
@Override
114116
public void setMessageSource(MessageSource messageSource) {
115117
this.messages = new MessageSourceAccessor(messageSource);
116118
}

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ class ArrayFilterer<T> implements Filterer<T> {
5252
*
5353
* @see org.springframework.security.acls.afterinvocation.Filterer#getFilteredObject()
5454
*/
55+
@Override
5556
@SuppressWarnings("unchecked")
5657
public T[] getFilteredObject() {
5758
// Recreate an array of same type and filter the removed objects.
@@ -80,21 +81,25 @@ public T[] getFilteredObject() {
8081
*
8182
* @see org.springframework.security.acls.afterinvocation.Filterer#iterator()
8283
*/
84+
@Override
8385
public Iterator<T> iterator() {
8486
return new Iterator<T>() {
8587
private int index = 0;
8688

89+
@Override
8790
public boolean hasNext() {
8891
return this.index < ArrayFilterer.this.list.length;
8992
}
9093

94+
@Override
9195
public T next() {
9296
if (!hasNext()) {
9397
throw new NoSuchElementException();
9498
}
9599
return ArrayFilterer.this.list[this.index++];
96100
}
97101

102+
@Override
98103
public void remove() {
99104
throw new UnsupportedOperationException();
100105
}
@@ -105,6 +110,7 @@ public void remove() {
105110
*
106111
* @see org.springframework.security.acls.afterinvocation.Filterer#remove(java.lang.Object)
107112
*/
113+
@Override
108114
public void remove(T object) {
109115
this.removeList.add(object);
110116
}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ class CollectionFilterer<T> implements Filterer<T> {
5555
*
5656
* @see org.springframework.security.acls.afterinvocation.Filterer#getFilteredObject()
5757
*/
58+
@Override
5859
public Object getFilteredObject() {
5960
// Now the Iterator has ended, remove Objects from Collection
6061
Iterator<T> removeIter = this.removeList.iterator();
@@ -77,6 +78,7 @@ public Object getFilteredObject() {
7778
*
7879
* @see org.springframework.security.acls.afterinvocation.Filterer#iterator()
7980
*/
81+
@Override
8082
public Iterator<T> iterator() {
8183
return this.collection.iterator();
8284
}
@@ -85,6 +87,7 @@ public Iterator<T> iterator() {
8587
*
8688
* @see org.springframework.security.acls.afterinvocation.Filterer#remove(java.lang.Object)
8789
*/
90+
@Override
8891
public void remove(T object) {
8992
this.removeList.add(object);
9093
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ interface Filterer<T> extends Iterable<T> {
3636
* Returns an iterator over the filtered collection or array.
3737
* @return an Iterator
3838
*/
39+
@Override
3940
Iterator<T> iterator();
4041

4142
/**

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ protected AbstractPermission(int mask, char code) {
5050
this.code = code;
5151
}
5252

53+
@Override
5354
public final boolean equals(Object arg0) {
5455
if (arg0 == null) {
5556
return false;
@@ -64,18 +65,22 @@ public final boolean equals(Object arg0) {
6465
return (this.mask == rhs.getMask());
6566
}
6667

68+
@Override
6769
public final int getMask() {
6870
return this.mask;
6971
}
7072

73+
@Override
7174
public String getPattern() {
7275
return AclFormattingUtils.printBinary(this.mask, this.code);
7376
}
7477

78+
@Override
7579
public final String toString() {
7680
return this.getClass().getSimpleName() + "[" + getPattern() + "=" + this.mask + "]";
7781
}
7882

83+
@Override
7984
public final int hashCode() {
8085
return this.mask;
8186
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ public AclAuthorizationStrategyImpl(GrantedAuthority... auths) {
7777
}
7878
}
7979

80+
@Override
8081
public void securityCheck(Acl acl, int changeType) {
8182
if ((SecurityContextHolder.getContext() == null)
8283
|| (SecurityContextHolder.getContext().getAuthentication() == null)

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
*/
2727
public class ConsoleAuditLogger implements AuditLogger {
2828

29+
@Override
2930
public void logIfNeeded(boolean granted, AccessControlEntry ace) {
3031
Assert.notNull(ace, "AccessControlEntry required");
3132

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ public CumulativePermission set(Permission permission) {
5656
return this;
5757
}
5858

59+
@Override
5960
public String getPattern() {
6061
return this.pattern;
6162
}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ protected void registerPermission(Permission perm, String permissionName) {
113113
this.registeredPermissionsByName.put(permissionName, perm);
114114
}
115115

116+
@Override
116117
public Permission buildFromMask(int mask) {
117118
if (this.registeredPermissionsByInteger.containsKey(mask)) {
118119
// The requested mask has an exact match against a statically-defined
@@ -140,6 +141,7 @@ public Permission buildFromMask(int mask) {
140141
return permission;
141142
}
142143

144+
@Override
143145
public Permission buildFromName(String name) {
144146
Permission p = this.registeredPermissionsByName.get(name);
145147

@@ -150,6 +152,7 @@ public Permission buildFromName(String name) {
150152
return p;
151153
}
152154

155+
@Override
153156
public List<Permission> buildFromNames(List<String> names) {
154157
if ((names == null) || (names.size() == 0)) {
155158
return Collections.emptyList();

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ public DefaultPermissionGrantingStrategy(AuditLogger auditLogger) {
7070
* @throws NotFoundException if an exact ACE for one of the permission bit masks and
7171
* SID combination could not be found
7272
*/
73+
@Override
7374
public boolean isGranted(Acl acl, List<Permission> permission, List<Sid> sids, boolean administrativeMode)
7475
throws NotFoundException {
7576

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ public EhCacheBasedAclCache(Ehcache cache, PermissionGrantingStrategy permission
5555
this.aclAuthorizationStrategy = aclAuthorizationStrategy;
5656
}
5757

58+
@Override
5859
public void evictFromCache(Serializable pk) {
5960
Assert.notNull(pk, "Primary key (identifier) required");
6061

@@ -66,6 +67,7 @@ public void evictFromCache(Serializable pk) {
6667
}
6768
}
6869

70+
@Override
6971
public void evictFromCache(ObjectIdentity objectIdentity) {
7072
Assert.notNull(objectIdentity, "ObjectIdentity required");
7173

@@ -77,6 +79,7 @@ public void evictFromCache(ObjectIdentity objectIdentity) {
7779
}
7880
}
7981

82+
@Override
8083
public MutableAcl getFromCache(ObjectIdentity objectIdentity) {
8184
Assert.notNull(objectIdentity, "ObjectIdentity required");
8285

@@ -95,6 +98,7 @@ public MutableAcl getFromCache(ObjectIdentity objectIdentity) {
9598
return initializeTransientFields((MutableAcl) element.getValue());
9699
}
97100

101+
@Override
98102
public MutableAcl getFromCache(Serializable pk) {
99103
Assert.notNull(pk, "Primary key (identifier) required");
100104

@@ -113,6 +117,7 @@ public MutableAcl getFromCache(Serializable pk) {
113117
return initializeTransientFields((MutableAcl) element.getValue());
114118
}
115119

120+
@Override
116121
public void putInCache(MutableAcl acl) {
117122
Assert.notNull(acl, "Acl required");
118123
Assert.notNull(acl.getObjectIdentity(), "ObjectIdentity required");
@@ -147,6 +152,7 @@ private MutableAcl initializeTransientFields(MutableAcl value) {
147152
return value;
148153
}
149154

155+
@Override
150156
public void clearCache() {
151157
this.cache.removeAll();
152158
}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,12 @@
3131
*/
3232
public class ObjectIdentityRetrievalStrategyImpl implements ObjectIdentityRetrievalStrategy, ObjectIdentityGenerator {
3333

34+
@Override
3435
public ObjectIdentity getObjectIdentity(Object domainObject) {
3536
return new ObjectIdentityImpl(domainObject);
3637
}
3738

39+
@Override
3840
public ObjectIdentity createObjectIdentity(Serializable id, String type) {
3941
return new ObjectIdentityImpl(type, id);
4042
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ public SidRetrievalStrategyImpl(RoleHierarchy roleHierarchy) {
5151
this.roleHierarchy = roleHierarchy;
5252
}
5353

54+
@Override
5455
public List<Sid> getSids(Authentication authentication) {
5556
Collection<? extends GrantedAuthority> authorities = this.roleHierarchy
5657
.getReachableGrantedAuthorities(authentication.getAuthorities());

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ public SpringCacheBasedAclCache(Cache cache, PermissionGrantingStrategy permissi
5656
this.aclAuthorizationStrategy = aclAuthorizationStrategy;
5757
}
5858

59+
@Override
5960
public void evictFromCache(Serializable pk) {
6061
Assert.notNull(pk, "Primary key (identifier) required");
6162

@@ -67,6 +68,7 @@ public void evictFromCache(Serializable pk) {
6768
}
6869
}
6970

71+
@Override
7072
public void evictFromCache(ObjectIdentity objectIdentity) {
7173
Assert.notNull(objectIdentity, "ObjectIdentity required");
7274

@@ -78,16 +80,19 @@ public void evictFromCache(ObjectIdentity objectIdentity) {
7880
}
7981
}
8082

83+
@Override
8184
public MutableAcl getFromCache(ObjectIdentity objectIdentity) {
8285
Assert.notNull(objectIdentity, "ObjectIdentity required");
8386
return getFromCache((Object) objectIdentity);
8487
}
8588

89+
@Override
8690
public MutableAcl getFromCache(Serializable pk) {
8791
Assert.notNull(pk, "Primary key (identifier) required");
8892
return getFromCache((Object) pk);
8993
}
9094

95+
@Override
9196
public void putInCache(MutableAcl acl) {
9297
Assert.notNull(acl, "Acl required");
9398
Assert.notNull(acl.getObjectIdentity(), "ObjectIdentity required");
@@ -123,6 +128,7 @@ private MutableAcl initializeTransientFields(MutableAcl value) {
123128
return value;
124129
}
125130

131+
@Override
126132
public void clearCache() {
127133
this.cache.clear();
128134
}

0 commit comments

Comments
 (0)