Skip to content

Commit

Permalink
Fix-up Javadocs that break compilation in JDK8+
Browse files Browse the repository at this point in the history
  • Loading branch information
Kortanul committed Feb 26, 2018
1 parent 7e26b49 commit aa812ab
Show file tree
Hide file tree
Showing 38 changed files with 267 additions and 232 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
* "Portions Copyrighted [year] [name of copyright owner]"
* ====================
* Portions Copyrighted 2010-2015 ForgeRock AS.
* Portions Copyright 2018 Wren Security.
*/

package org.identityconnectors.framework.impl.api.local;
Expand Down Expand Up @@ -346,8 +347,8 @@ private PooledObject borrowIdleObject() throws InterruptedException {

/**
* Closes any idle objects in the pool.
* <p/>
* Existing active objects will remain alive and be allowed to shutdown
*
* <p>Existing active objects will remain alive and be allowed to shutdown
* gracefully, but no more objects will be allocated.
*/
public void shutdown() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
* "Portions Copyrighted [year] [name of copyright owner]"
* ====================
* Portions Copyrighted 2010-2013 ForgeRock AS.
* Portions Copyright 2018 Wren Security.
*/

package org.identityconnectors.framework.impl.api.local;
Expand All @@ -31,9 +32,9 @@ public interface ObjectPoolHandler<T> {
/**
* Validates, copies and updates the original
* {@code ObjectPoolConfiguration}.
* <p/>
* This class can validate and if necessary it changes the {@code original}
* configuration.
*
* <p>This class can validate and if necessary it changes the
* {@code original} configuration.
*
* @param original
* custom configured instance.
Expand All @@ -43,17 +44,17 @@ public interface ObjectPoolHandler<T> {

/**
* Makes a new instance of the pooled object.
* <p/>
* This method is called whenever a new instance is needed.
*
* <p>This method is called whenever a new instance is needed.
*
* @return new instance of T.
*/
public T makeObject();

/**
* Tests the borrowed object.
* <p/>
* This method is invoked on head instances to make sure they can be
*
* <p>This method is invoked on head instances to make sure they can be
* borrowed from the pool.
*
* @param object
Expand All @@ -63,8 +64,8 @@ public interface ObjectPoolHandler<T> {

/**
* Disposes the object.
* <p/>
* This method is invoked on every instance when it is being "dropped" from
*
* <p>This method is invoked on every instance when it is being "dropped" from
* the pool (whether due to the response from {@link #testObject(Object)},
* or for reasons specific to the pool implementation.)
*
Expand All @@ -75,8 +76,8 @@ public interface ObjectPoolHandler<T> {

/**
* Releases any allocated resources.
* <p/>
* Existing active objects will remain alive and be allowed to shutdown
*
* <p>Existing active objects will remain alive and be allowed to shutdown
* gracefully, but no more objects will be allocated.
*/
public void shutdown();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
* Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
Expand Down Expand Up @@ -44,8 +45,6 @@ public AuthenticationImpl(final ConnectorOperationalContext context,

/**
* Authenticate using the basic credentials.
*
* @see AuthenticationOpTests#authenticate(String, String)
*/
public Uid authenticate(final ObjectClass objectClass, final String username,
final GuardedString password,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
* Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
Expand Down Expand Up @@ -69,9 +70,6 @@ public BatchImpl(final ConnectorOperationalContext context, final Connector conn
this.referenceCounter = referenceCounter;
}

/**
* {@inherit}
*/
public Subscription executeBatch(final List<BatchTask> tasks, final Observer<BatchResult> observer,
final OperationOptions options) {
if (tasks == null || tasks.size() == 0) {
Expand Down Expand Up @@ -109,9 +107,6 @@ public Subscription executeBatch(final List<BatchTask> tasks, final Observer<Bat

}

/**
* {@inherit}
*/
public Subscription queryBatch(final BatchToken batchToken, final Observer<BatchResult> observer,
final OperationOptions options) {
Assertions.nullCheck(batchToken, "batchToken");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2013 ForgeRock AS. All Rights Reserved
* Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
Expand Down Expand Up @@ -36,14 +37,11 @@
/**
* RemoteWrappedException wraps every exception which are received from Remote
* Connector Server.
* <p/>
* <b>This Exception is not allowed to use in Connectors!!!</b>
* <p/>
*
* <p><b>This Exception is not allowed for use by Connectors</b>
*
*
* This type of exception is not allowed to be serialise because this exception
* represents any after deserialization.
* <p>This type of exception is not allowed to be serialise because this
* exception represents any after deserialization.
*
* This code example show how to get the remote stack trace and how to use the
* same catches to handle the exceptions regardless its origin.
Expand All @@ -64,7 +62,7 @@
* t.printStackTrace();
* }
* }
* <code>
* </code>
* </pre>
*
* @author Laszlo Hordos
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
* Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
Expand All @@ -29,70 +30,95 @@
*/
public interface ObjectDecoder {
/**
* Reads an object using the appropriate serializer for that object
* @param fieldName A hint of the field name. Ignored for binary
* serialization. The subelement name for xml serialization
* @expectedType Ignored for binary serialization. For xml serialization,
* this must be specified if it was written in-line.
* @dflt The default value if there is no value.
* Reads an object using the appropriate serializer for that object.
*
* @param fieldName
* A hint of the field name. Ignored for binary serialization. The
* subelement name for xml serialization
* @param expectedType
* Ignored for binary serialization. For xml serialization, this must be
* specified if it was written in-line.
* @param dflt
* The default value if there is no value.
*/
public Object readObjectField(String fieldName,
Class<?> expectedType,
Object dflt);

/**
* Reads a boolean.
* @param fieldName A hint of the field name. Ignored for binary
* serialization. The attribute name for xml serialization
* @dflt The default value if there is no value.
*
* @param fieldName
* A hint of the field name. Ignored for binary serialization. The
* attribute name for xml serialization
* @param dflt
* The default value if there is no value.
*/
public boolean readBooleanField(String fieldName, boolean dflt);

/**
* Reads an int.
* @param fieldName A hint of the field name. Ignored for binary
* serialization. The attribute name for xml serialization
* @dflt The default value if there is no value.
*
* @param fieldName
* A hint of the field name. Ignored for binary serialization. The
* attribute name for xml serialization
* @param dflt
* The default value if there is no value.
*/
public int readIntField(String fieldName, int dflt);

/**
* Reads a long.
* @param fieldName A hint of the field name. Ignored for binary
* serialization. The attribute name for xml serialization
* @dflt The default value if there is no value.
*
* @param fieldName
* A hint of the field name. Ignored for binary serialization. The
* attribute name for xml serialization
* @param dflt
* The default value if there is no value.
*/
public long readLongField(String fieldName, long dflt);

/**
* Reads a float.
* @param fieldName A hint of the field name. Ignored for binary
* serialization. The attribute name for xml serialization
* @dflt The default value if there is no value.
*
* @param fieldName
* A hint of the field name. Ignored for binary serialization. The
* attribute name for xml serialization
* @param dflt
* The default value if there is no value.
*/
public float readFloatField(String fieldName, float dflt );

/**
* Reads a Class.
* @param fieldName A hint of the field name. Ignored for binary
* serialization. The attribute name for xml serialization
* @dflt The default value if there is no value.
*
* @param fieldName
* A hint of the field name. Ignored for binary serialization. The
* attribute name for xml serialization
* @param dflt
* The default value if there is no value.
*/
public Class<?> readClassField(String fieldName, Class<?> dflt );

/**
* Reads a String.
* @param fieldName A hint of the field name. Ignored for binary
* serialization. The attribute name for xml serialization
* @dflt The default value if there is no value.
*
* @param fieldName
* A hint of the field name. Ignored for binary serialization. The
* attribute name for xml serialization
* @param dflt
* The default value if there is no value.
*/
public String readStringField(String fieldName, String dflt );

/**
* Reads a double.
* @param fieldName A hint of the field name. Ignored for binary
* serialization. The attribute name for xml serialization
* @dflt The default value if there is no value.
*
* @param fieldName
* A hint of the field name. Ignored for binary serialization. The
* attribute name for xml serialization
* @param dflt
* The default value if there is no value.
*/
public double readDoubleField(String fieldName, double dflt );

Expand Down Expand Up @@ -143,7 +169,6 @@ public Object readObjectField(String fieldName,

/**
* Returns the number of anonymous sub-objects.
* @return
*/
public int getNumSubObjects();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
* Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
Expand Down Expand Up @@ -355,8 +356,6 @@ public void setBundleParentClassLoader(final ClassLoader bundleParentClassLoader

/**
* Gets the time when the servers was started last time.
* <p/>
* {@code System.currentTimeMillis()}
*
* @return last start dateTime in milliseconds
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2013 ForgeRock AS. All rights reserved.
* Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
Expand Down Expand Up @@ -75,7 +76,6 @@

/**
* The OSGi ConnectorInfoManager Implementation ...
* <p/>
*
* @author Laszlo Hordos
* @since 1.1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
* Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
Expand All @@ -23,10 +24,11 @@
*/

/**
* Provide the Google Protocol Buffer Messages required for the Remote OpenICF Server communication.
* <p/>
* The messages are extracted for easy extensibility in the future.
* Provide the Google Protocol Buffer Messages required for the Remote OpenICF
* Server communication.
*
* <p>The messages are extracted for easy extensibility in the future.
*
* @since 1.5
*/
package org.forgerock.openicf.common.protobuf;
package org.forgerock.openicf.common.protobuf;
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2015 ForgeRock AS. All rights reserved.
* Portions Copyright 2018 Wren Security.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
Expand Down Expand Up @@ -29,10 +30,9 @@

/**
* A LocalRequest represents a remotely requested procedure call locally.
* <p/>
* The {@link RemoteRequest} and LocalRequest are the representation of the same
* call on caller and receiver side.
*
* <p>The {@link RemoteRequest} and LocalRequest are the representation of the
* same call on caller and receiver side.
*/
public abstract class LocalRequest<V, E extends Exception, G extends RemoteConnectionGroup<G, H, P>, H extends RemoteConnectionHolder<G, H, P>, P extends RemoteConnectionContext<G, H, P>>
implements ResultHandler<V>, ExceptionHandler<E> {
Expand All @@ -48,10 +48,12 @@ protected LocalRequest(final long requestId, final H socket) {
}

/**
* Check if this object was {@ref inconsistent}-ed and don't dispose.
* Check if this object was marked inconsistent and should not be disposed.
*
* @return 'true' when object is still active or 'false' when this can be
* disposed.
*
* @see #inconsistent()
*/
public abstract boolean check();

Expand Down
Loading

0 comments on commit aa812ab

Please sign in to comment.