[OLINGO-659] still more API clean-up
Signed-off-by: Michael Bolz <michael.bolz@sap.com>
This commit is contained in:
Klaus Straubinger
Michael Bolz
parent
fbca4ef33e
commit
805028da2f
|
|
@ -29,13 +29,9 @@ public class DeletedEntity {
|
|||
* Reason of the removal from the list
|
||||
*/
|
||||
public enum Reason {
|
||||
/**
|
||||
* The entity was deleted
|
||||
*/
|
||||
/** The entity was deleted. */
|
||||
deleted,
|
||||
/**
|
||||
* The data of the entity as changed and not any longer part of the response
|
||||
*/
|
||||
/** The data of the entity has changed and is not any longer part of the response. */
|
||||
changed
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ package org.apache.olingo.commons.api.data;
|
|||
import java.net.URI;
|
||||
|
||||
/**
|
||||
* Data representation for a operation.
|
||||
* Data representation for an operation.
|
||||
*/
|
||||
public class Operation {
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,6 @@
|
|||
* under the License.
|
||||
*/
|
||||
/**
|
||||
* Contains all the data objects of an OData responses and OData requests
|
||||
* Contains all the data objects of OData responses and OData requests
|
||||
*/
|
||||
package org.apache.olingo.commons.api.data;
|
||||
|
|
@ -17,8 +17,7 @@
|
|||
* under the License.
|
||||
*/
|
||||
/**
|
||||
* Contains representations for all constants related
|
||||
* EDM objects created during the URI parsing
|
||||
* Contains representations for constants related to EDM objects.
|
||||
*/
|
||||
package org.apache.olingo.commons.api.edm.constants;
|
||||
|
||||
|
|
|
|||
|
|
@ -43,9 +43,6 @@ public abstract class ComposedGeospatial<T extends Geospatial> extends Geospatia
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc }
|
||||
*/
|
||||
@Override
|
||||
public Iterator<T> iterator() {
|
||||
return this.geospatials.iterator();
|
||||
|
|
|
|||
|
|
@ -17,6 +17,6 @@
|
|||
* under the License.
|
||||
*/
|
||||
/**
|
||||
* Contains all OData errors and exceptions related classes.
|
||||
* Contains all OData errors and exception-related classes.
|
||||
*/
|
||||
package org.apache.olingo.commons.api.ex;
|
||||
|
|
@ -24,7 +24,9 @@ import java.util.Map;
|
|||
import java.util.TreeMap;
|
||||
|
||||
/**
|
||||
* Helper class which is only used within this package (<code>AcceptType</code> and <code>ContentType</code> handling).
|
||||
* Helper class which is only used within this package.
|
||||
* @see AcceptType
|
||||
* @see ContentType
|
||||
*/
|
||||
final class TypeUtil {
|
||||
|
||||
|
|
@ -102,13 +104,15 @@ final class TypeUtil {
|
|||
}
|
||||
|
||||
/**
|
||||
* Validate that parameter name and parameter value are valid .
|
||||
*
|
||||
* @param parameterName must be <code>not null</code>, <code>not empty</code> and <code>contains no whitespace
|
||||
* characters</code>
|
||||
* @param parameterValue must be <code>not null</code>, <code>not empty</code> and <code>not start with a whitespace
|
||||
* character</code>
|
||||
* @throws IllegalArgumentException if one of the above requirements are not met
|
||||
* Validates that parameter name and parameter value are valid:
|
||||
* <ul>
|
||||
* <li>not <code>null</code></li>
|
||||
* <li>not empty</li>
|
||||
* <li>does not contain whitespace characters (name), or does not start with whitespace (value), respectively</li>
|
||||
* </ul>
|
||||
* @param parameterName name
|
||||
* @param parameterValue value
|
||||
* @throws IllegalArgumentException if one of the above requirements is not met
|
||||
*/
|
||||
static void validateParameterNameAndValue(final String parameterName, final String parameterValue)
|
||||
throws IllegalArgumentException {
|
||||
|
|
|
|||
|
|
@ -17,7 +17,9 @@
|
|||
* under the License.
|
||||
*/
|
||||
/**
|
||||
* Contains all the format related objects (also related to http headers <coder>Prefer</coder>, <code>Accepted</code>
|
||||
* and <code>Content-Type</code>) which are used for handling of an OData responses and OData requests.
|
||||
* Contains all the format-related objects used for the handling of
|
||||
* OData responses and OData requests.
|
||||
* They are related to the HTTP headers <code>Prefer</code>, <code>Accept</code>,
|
||||
* and <code>Content-Type</code>.
|
||||
*/
|
||||
package org.apache.olingo.commons.api.format;
|
||||
|
|
@ -17,6 +17,6 @@
|
|||
* under the License.
|
||||
*/
|
||||
/**
|
||||
* Contains all the http related objects which are used for handling of an OData responses and OData requests.
|
||||
* Contains all the HTTP related objects which are used for handling of OData responses and OData requests.
|
||||
*/
|
||||
package org.apache.olingo.commons.api.http;
|
||||
|
|
@ -26,9 +26,11 @@ import java.util.List;
|
|||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* HttpHeader container.
|
||||
* HttpHeader container for internal use in this package.
|
||||
* @see ODataRequest
|
||||
* @see ODataResponse
|
||||
*/
|
||||
public class HttpHeaders {
|
||||
final class HttpHeaders {
|
||||
private final Map<String, List<String>> headers = new LinkedHashMap<String, List<String>>();
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ public class ODataRequest {
|
|||
}
|
||||
|
||||
/**
|
||||
* <p>Set a header to the response.</p>
|
||||
* <p>Sets a header in the request.</p>
|
||||
* <p>The header name will be handled as case-insensitive key.</p>
|
||||
* <p>If a header already exists then the header will be replaced by this new value.</p>
|
||||
* @param name case-insensitive header name
|
||||
|
|
|
|||
|
|
@ -18,20 +18,17 @@
|
|||
*/
|
||||
/**
|
||||
* Olingo Server API
|
||||
* <p>
|
||||
* OData Library is a protocol implementation of the OData V4.0 standard. For details of this standard
|
||||
* see <a href="http://odata.org">odata.org</a>.
|
||||
* <p>
|
||||
* This API is intended to help implement an OData service. An OData service consists of a metadata provider
|
||||
* implementation and an OData processor implementation.
|
||||
* <p>
|
||||
* An OData service can be exposed by a web application using the standard java servlet API. See the Olingo tutorials
|
||||
* section on how to implement a V4 service for further information:
|
||||
* <a href="http://olingo.apache.org/doc/odata4/index.html">http://olingo.apache.org/doc/odata4/index.html
|
||||
* <p>
|
||||
* The main entry point is the org.apache.olingo.server.api.OData class. Use the newInstance() method to create a new
|
||||
* object and start providing your service from there.
|
||||
*
|
||||
* <p>The OData Library is a protocol implementation of the OData V4.0 standard.
|
||||
* For details of this standard see <a href="http://odata.org">odata.org</a>.</p>
|
||||
* <p>This API is intended to help implementing an OData service.
|
||||
* An OData service consists of a metadata provider implementation and an
|
||||
* OData processor implementation.</p>
|
||||
* <p>An OData service can be exposed by a web application using the standard java servlet API.
|
||||
* For further information, see the <a href="http://olingo.apache.org/doc/odata4/">Olingo
|
||||
* tutorials</a> on how to implement an OData service.</p>
|
||||
* <p>The main entry point is the org.apache.olingo.server.api.OData class.
|
||||
* Use the newInstance() method to create a new object and
|
||||
* start providing your service from there.</p>
|
||||
*/
|
||||
package org.apache.olingo.server.api;
|
||||
|
||||
|
|
|
|||
|
|
@ -18,17 +18,17 @@
|
|||
*/
|
||||
/**
|
||||
* Olingo Processors
|
||||
* <p>
|
||||
* Processors are used to handle OData requests and send back the OData reponse. Before a specific processor is called
|
||||
* the Olingo library will parse the URI and validate it. Afterwards the Processor which matches the return type is
|
||||
* called. E.g.: If a primitive property is requested by the URI we will call the PrimitveProcessor.read method.
|
||||
* <p>
|
||||
* Processors can be registered at the {@link org.apache.olingo.server.api.ODataHttpHandler} object. Per default we will
|
||||
* have the {@link org.apache.olingo.server.api.processor.DefaultProcessor} registered to perform basic functionality
|
||||
* like delivering the metadata and service document as well as rendering an OData error.
|
||||
* <br>In case an application would like to perform custom tasks for these cases a new
|
||||
* {@link org.apache.olingo.server.api.processor.ServiceDocumentProcessor} can be registered in order to overwrite the
|
||||
* default behaviour.
|
||||
* <p>Processors are used to handle OData requests and send back the OData reponse.
|
||||
* Before a specific processor is called the Olingo library will parse the URI and validate it.
|
||||
* Afterwards the Processor which matches the return type is called.
|
||||
* Example: If a primitive property is requested by the URI we will call the
|
||||
* PrimitiveProcessor.readPrimitive method.</p>
|
||||
* <p>Processors can be registered at the {@link org.apache.olingo.server.api.ODataHttpHandler} object.
|
||||
* Per default the {@link org.apache.olingo.server.api.processor.DefaultProcessor} is registered
|
||||
* to perform basic functionality like delivering the metadata and service documents, respectively,
|
||||
* as well as rendering an OData error.
|
||||
* In case an application would like to perform custom tasks for these cases a new
|
||||
* {@link org.apache.olingo.server.api.processor.ServiceDocumentProcessor} can be registered
|
||||
* in order to overwrite the default behavior.
|
||||
*/
|
||||
package org.apache.olingo.server.api.processor;
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue