[OLINGO-659] Added more javadocs
Project: http://git-wip-us.apache.org/repos/asf/olingo-odata4/repo Commit: http://git-wip-us.apache.org/repos/asf/olingo-odata4/commit/9ffe4c89 Tree: http://git-wip-us.apache.org/repos/asf/olingo-odata4/tree/9ffe4c89 Diff: http://git-wip-us.apache.org/repos/asf/olingo-odata4/diff/9ffe4c89 Branch: refs/heads/master Commit: 9ffe4c8928ea3333f1e7feb939fa26f7d468f66a Parents: 649614b Author: Michael Bolz <[email protected]> Authored: Thu Sep 10 15:29:51 2015 +0200 Committer: Michael Bolz <[email protected]> Committed: Thu Sep 10 15:29:51 2015 +0200 ---------------------------------------------------------------------- .../client/core/edm/ClientCsdlEdmProvider.java | 2 +- .../org/apache/olingo/commons/api/edm/Edm.java | 10 +- .../olingo/commons/api/edm/EdmAnnotatable.java | 9 + .../commons/api/edm/EdmBindingTarget.java | 2 +- .../commons/api/edm/EdmEntityContainer.java | 8 +- .../olingo/commons/api/edm/EdmEntityType.java | 2 +- .../olingo/commons/api/edm/EdmEnumType.java | 4 +- .../commons/api/edm/EdmNavigationProperty.java | 4 +- .../olingo/commons/api/edm/EdmOperation.java | 7 +- .../commons/api/edm/EdmStructuredType.java | 8 +- .../commons/api/edm/FullQualifiedName.java | 8 +- .../api/edm/constants/ODataServiceVersion.java | 24 ++- .../api/edm/provider/CsdlAbstractEdmItem.java | 14 ++ .../edm/provider/CsdlAbstractEdmProvider.java | 2 +- .../commons/api/edm/provider/CsdlAction.java | 1 + .../api/edm/provider/CsdlActionImport.java | 6 +- .../commons/api/edm/provider/CsdlAliasInfo.java | 8 +- .../api/edm/provider/CsdlAnnotatable.java | 2 +- .../api/edm/provider/CsdlAnnotation.java | 18 +- .../api/edm/provider/CsdlAnnotations.java | 31 ++++ .../api/edm/provider/CsdlBindingTarget.java | 51 ++++++ .../api/edm/provider/CsdlComplexType.java | 3 + .../api/edm/provider/CsdlEdmProvider.java | 132 ++++++++------- .../api/edm/provider/CsdlEntityContainer.java | 81 +++++++++ .../edm/provider/CsdlEntityContainerInfo.java | 25 +++ .../commons/api/edm/provider/CsdlEntitySet.java | 14 ++ .../api/edm/provider/CsdlEntitySetPath.java | 25 +++ .../api/edm/provider/CsdlEntityType.java | 25 +++ .../api/edm/provider/CsdlEnumMember.java | 20 +++ .../commons/api/edm/provider/CsdlEnumType.java | 60 +++++++ .../api/edm/provider/CsdlExpression.java | 3 + .../commons/api/edm/provider/CsdlFunction.java | 14 ++ .../api/edm/provider/CsdlFunctionImport.java | 36 ++++ .../commons/api/edm/provider/CsdlNamed.java | 9 +- .../edm/provider/CsdlNavigationProperty.java | 97 +++++++++++ .../provider/CsdlNavigationPropertyBinding.java | 25 +++ .../commons/api/edm/provider/CsdlOnDelete.java | 14 ++ .../api/edm/provider/CsdlOnDeleteAction.java | 16 +- .../commons/api/edm/provider/CsdlOperation.java | 77 +++++++++ .../api/edm/provider/CsdlOperationImport.java | 29 ++++ .../commons/api/edm/provider/CsdlParameter.java | 108 ++++++++++++ .../commons/api/edm/provider/CsdlProperty.java | 141 ++++++++++++++++ .../api/edm/provider/CsdlPropertyRef.java | 20 +++ .../edm/provider/CsdlReferentialConstraint.java | 25 +++ .../api/edm/provider/CsdlReturnType.java | 91 ++++++++++ .../commons/api/edm/provider/CsdlSchema.java | 169 ++++++++++++++++++- .../commons/api/edm/provider/CsdlSingleton.java | 3 + .../api/edm/provider/CsdlStructuralType.java | 108 ++++++++++++ .../commons/api/edm/provider/CsdlTerm.java | 125 ++++++++++++++ .../api/edm/provider/CsdlTypeDefinition.java | 81 +++++++++ .../annotation/AnnotationExpression.java | 8 +- .../edm/provider/annotation/AnnotationPath.java | 2 +- .../api/edm/provider/annotation/Apply.java | 6 +- .../api/edm/provider/annotation/Cast.java | 6 +- .../api/edm/provider/annotation/Collection.java | 2 +- .../ConstantAnnotationExpression.java | 14 +- .../annotation/DynamicAnnotationExpression.java | 100 +++++------ .../commons/api/edm/provider/annotation/If.java | 8 +- .../api/edm/provider/annotation/IsOf.java | 14 +- .../edm/provider/annotation/LabeledElement.java | 6 +- .../annotation/LabeledElementReference.java | 2 +- .../annotation/NavigationPropertyPath.java | 2 +- .../api/edm/provider/annotation/Not.java | 8 +- .../api/edm/provider/annotation/Path.java | 2 +- .../edm/provider/annotation/PropertyValue.java | 4 +- .../api/edm/provider/annotation/Record.java | 6 +- .../TwoParamsOpDynamicAnnotationExpression.java | 10 +- .../api/edm/provider/annotation/UrlRef.java | 2 +- .../olingo/commons/api/ex/ODataError.java | 6 +- .../commons/core/edm/EdmProviderImpl.java | 2 +- .../server/core/SchemaBasedEdmProvider.java | 2 +- 71 files changed, 1789 insertions(+), 220 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/client-core/src/main/java/org/apache/olingo/client/core/edm/ClientCsdlEdmProvider.java ---------------------------------------------------------------------- diff --git a/lib/client-core/src/main/java/org/apache/olingo/client/core/edm/ClientCsdlEdmProvider.java b/lib/client-core/src/main/java/org/apache/olingo/client/core/edm/ClientCsdlEdmProvider.java index 3c805e7..1571a13 100644 --- a/lib/client-core/src/main/java/org/apache/olingo/client/core/edm/ClientCsdlEdmProvider.java +++ b/lib/client-core/src/main/java/org/apache/olingo/client/core/edm/ClientCsdlEdmProvider.java @@ -202,7 +202,7 @@ public class ClientCsdlEdmProvider extends CsdlAbstractEdmProvider { } @Override - public CsdlAnnotatable getAnnoatatable(FullQualifiedName annotatedName) throws ODataException { + public CsdlAnnotatable getAnnotatable(FullQualifiedName annotatedName) throws ODataException { final CsdlSchema schema = xmlSchemas.get(annotatedName.getNamespace()); if (schema != null) { return schema.getAnnotatables().get(annotatedName.getName()); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Edm.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Edm.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Edm.java index bfe1953..cdd0e21 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Edm.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Edm.java @@ -56,7 +56,7 @@ public interface Edm { * <br/> * See {@link EdmEntityContainer} for more information. * - * @param name + * @param name full qualified name of entity container * @return {@link EdmEntityContainer} */ EdmEntityContainer getEntityContainer(FullQualifiedName name); @@ -66,7 +66,7 @@ public interface Edm { * <br/> * See {@link EdmEnumType} for more information * - * @param name + * @param name full qualified name of enum type * @return {@link EdmEnumType} */ EdmEnumType getEnumType(FullQualifiedName name); @@ -76,7 +76,7 @@ public interface Edm { * <br/> * See {@link EdmTypeDefinition} for more information * - * @param name + * @param name full qualified name of type definition * @return {@link EdmTypeDefinition} */ EdmTypeDefinition getTypeDefinition(FullQualifiedName name); @@ -86,7 +86,7 @@ public interface Edm { * <br/> * See {@link EdmEntityType} for more information. * - * @param name + * @param name full qualified name of entity type * @return {@link EdmEntityType} */ EdmEntityType getEntityType(FullQualifiedName name); @@ -96,7 +96,7 @@ public interface Edm { * <br/> * See {@link EdmComplexType} for more information. * - * @param name + * @param name full qualified name of complex type * @return {@link EdmComplexType} */ EdmComplexType getComplexType(FullQualifiedName name); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmAnnotatable.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmAnnotatable.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmAnnotatable.java index 04f0143..194b309 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmAnnotatable.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmAnnotatable.java @@ -25,7 +25,16 @@ import java.util.List; */ public interface EdmAnnotatable { + /** + * @param term term for annotation + * @return annotation according to term + */ EdmAnnotation getAnnotation(EdmTerm term); + /** + * Get list of all annotations. + * + * @return list of all annotations + */ List<EdmAnnotation> getAnnotations(); } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmBindingTarget.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmBindingTarget.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmBindingTarget.java index 52a228b..eaf11dd 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmBindingTarget.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmBindingTarget.java @@ -29,7 +29,7 @@ public interface EdmBindingTarget extends EdmNamed, EdmAnnotationsTarget, EdmAnn /** * Returns the target for a given path. * - * @param path + * @param path path for which the target is returned * @return {@link EdmBindingTarget} */ EdmBindingTarget getRelatedBindingTarget(String path); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntityContainer.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntityContainer.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntityContainer.java index 756db6c..7c69341 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntityContainer.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntityContainer.java @@ -41,7 +41,7 @@ public interface EdmEntityContainer extends EdmNamed, EdmAnnotationsTarget, EdmA /** * Get contained Singleton by name. * - * @param name + * @param name name of contained Singleton * @return {@link EdmSingleton} */ EdmSingleton getSingleton(String name); @@ -49,7 +49,7 @@ public interface EdmEntityContainer extends EdmNamed, EdmAnnotationsTarget, EdmA /** * Get contained EntitySet by name. * - * @param name + * @param name name of contained EntitySet * @return {@link EdmEntitySet} */ EdmEntitySet getEntitySet(String name); @@ -57,7 +57,7 @@ public interface EdmEntityContainer extends EdmNamed, EdmAnnotationsTarget, EdmA /** * Get contained ActionImport by name. * - * @param name + * @param name name of contained ActionImport * @return {@link EdmActionImport} */ EdmActionImport getActionImport(String name); @@ -65,7 +65,7 @@ public interface EdmEntityContainer extends EdmNamed, EdmAnnotationsTarget, EdmA /** * Get contained FunctionImport by name. * - * @param name + * @param name name of contained FunctionImport * @return {@link EdmFunctionImport} */ EdmFunctionImport getFunctionImport(String name); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntityType.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntityType.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntityType.java index e4dc248..eaf3463 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntityType.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntityType.java @@ -42,7 +42,7 @@ public interface EdmEntityType extends EdmStructuredType { /** * Get a key property ref by its name. * - * @param keyPredicateName + * @param keyPredicateName name of key property * @return {@link EdmKeyPropertyRef} for given name */ EdmKeyPropertyRef getKeyPropertyRef(String keyPredicateName); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEnumType.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEnumType.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEnumType.java index e0feda9..79461b7 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEnumType.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEnumType.java @@ -26,7 +26,9 @@ import java.util.List; public interface EdmEnumType extends EdmPrimitiveType, EdmAnnotationsTarget { /** - * @param name + * Get member according to given name + * + * @param name name of member * @return {@link EdmMember} for the given name */ EdmMember getMember(String name); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmNavigationProperty.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmNavigationProperty.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmNavigationProperty.java index 5f5037d..9f3a87c 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmNavigationProperty.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmNavigationProperty.java @@ -46,7 +46,9 @@ public interface EdmNavigationProperty extends EdmElement, EdmAnnotationsTarget, EdmNavigationProperty getPartner(); /** - * @param referencedPropertyName + * Get property name for referenced property + * + * @param referencedPropertyName name of referenced property * @return propertyName for this referenced property */ String getReferencingPropertyName(String referencedPropertyName); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmOperation.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmOperation.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmOperation.java index bb31fc3..15ff4a4 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmOperation.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmOperation.java @@ -26,7 +26,8 @@ import java.util.List; public interface EdmOperation extends EdmType, EdmAnnotatable { /** - * @param name + * Get parameter for given name + * @param name name of parameter * @return {@link EdmParameter} for this name */ EdmParameter getParameter(String name); @@ -39,7 +40,9 @@ public interface EdmOperation extends EdmType, EdmAnnotatable { List<String> getParameterNames(); /** - * @param bindingParameterEntitySet + * Get EdmEntitySet for the given binding parameters EntitySet + * + * @param bindingParameterEntitySet EntitySet of binding parameter * @return {@link EdmEntitySet} for this binding */ EdmEntitySet getReturnedEntitySet(EdmEntitySet bindingParameterEntitySet); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmStructuredType.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmStructuredType.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmStructuredType.java index 15fdd69..2b0f419 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmStructuredType.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmStructuredType.java @@ -30,7 +30,7 @@ public interface EdmStructuredType extends EdmType, EdmAnnotationsTarget, EdmAnn /** * Get property by name * - * @param name + * @param name name of property * @return simple, complex or navigation property as {@link EdmTyped} */ EdmElement getProperty(String name); @@ -45,7 +45,7 @@ public interface EdmStructuredType extends EdmType, EdmAnnotationsTarget, EdmAnn /** * Get structural property by name. * - * @param name + * @param name name of structural property * @return simple or complex property as {@link EdmTyped} */ EdmProperty getStructuralProperty(String name); @@ -53,7 +53,7 @@ public interface EdmStructuredType extends EdmType, EdmAnnotationsTarget, EdmAnn /** * Get navigation property by name. * - * @param name + * @param name name of navigation property * @return navigation property as {@link EdmTyped} */ EdmNavigationProperty getNavigationProperty(String name); @@ -75,7 +75,7 @@ public interface EdmStructuredType extends EdmType, EdmAnnotationsTarget, EdmAnn /** * Checks if this type is convertible to parameter {@code targetType} * - * @param targetType + * @param targetType target type for which compatibility is checked * @return true if this type is compatible to the testType (i.e., this type is a subtype of targetType) */ boolean compatibleTo(EdmType targetType); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/FullQualifiedName.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/FullQualifiedName.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/FullQualifiedName.java index 4852294..9f83d42 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/FullQualifiedName.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/FullQualifiedName.java @@ -34,8 +34,9 @@ public final class FullQualifiedName implements Serializable { private final String fqn; /** - * @param namespace - * @param name + * Create the FQN with given namespace and name + * @param namespace namespace of FQN + * @param name name of FQN */ public FullQualifiedName(final String namespace, final String name) { this.namespace = namespace; @@ -44,7 +45,8 @@ public final class FullQualifiedName implements Serializable { } /** - * @param namespaceAndName + * Create the FQN with given namespace and name (which is split of last <code>.</code> of the parameter). + * @param namespaceAndName namespace and name of FQN */ public FullQualifiedName(final String namespaceAndName) { final int dotIdx = namespaceAndName.lastIndexOf('.'); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/ODataServiceVersion.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/ODataServiceVersion.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/ODataServiceVersion.java index c6a2493..ef7cb65 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/ODataServiceVersion.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/ODataServiceVersion.java @@ -64,23 +64,29 @@ public enum ODataServiceVersion { } /** - * actual > comparedTo + * Check if <code>firstValue</code> is bigger then <code>secondValue</code> * - * @param actual - * @param comparedTo - * @return <code>true</code> if actual is bigger than comparedTo + * @param firstValue first value which is compared + * @param secondValue second value which is compared + * @return <code>true</code> if firstValue is bigger than secondValue */ - public static boolean isBiggerThan(final String actual, final String comparedTo) { - if (!validateDataServiceVersion(comparedTo) || !validateDataServiceVersion(actual)) { - throw new IllegalArgumentException("Illegal arguments: " + comparedTo + " and " + actual); + public static boolean isBiggerThan(final String firstValue, final String secondValue) { + if (!validateDataServiceVersion(secondValue) || !validateDataServiceVersion(firstValue)) { + throw new IllegalArgumentException("Illegal arguments: " + secondValue + " and " + firstValue); } - final double me = Double.parseDouble(extractDataServiceVersionString(actual)); - final double other = Double.parseDouble(extractDataServiceVersionString(comparedTo)); + final double me = Double.parseDouble(extractDataServiceVersionString(firstValue)); + final double other = Double.parseDouble(extractDataServiceVersionString(secondValue)); return me > other; } + /** + * Extract data service version and return it. + * + * @param rawDataServiceVersion raw data service version from which the service version gets extracted + * @return the extracted data service version + */ private static String extractDataServiceVersionString(final String rawDataServiceVersion) { if (rawDataServiceVersion != null) { final String[] pattern = rawDataServiceVersion.split(";"); http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAbstractEdmItem.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAbstractEdmItem.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAbstractEdmItem.java index ed5bce2..111ae22 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAbstractEdmItem.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAbstractEdmItem.java @@ -35,11 +35,25 @@ public abstract class CsdlAbstractEdmItem implements Serializable { private static final long serialVersionUID = 241190986363884784L; + /** + * Gets one by name. + * + * @param name the name + * @param items the items + * @return the one by name + */ protected <T extends CsdlNamed> T getOneByName(final String name, final Collection<T> items) { final List<T> result = getAllByName(name, items); return result.isEmpty() ? null : result.get(0); } + /** + * Gets all by name. + * + * @param name the name + * @param items the items + * @return the all by name + */ protected <T extends CsdlNamed> List<T> getAllByName(final String name, final Collection<T> items) { final List<T> result = new ArrayList<T>(); for (T type : items) { http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAbstractEdmProvider.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAbstractEdmProvider.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAbstractEdmProvider.java index 6f2b5bf..ba2e7b4 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAbstractEdmProvider.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAbstractEdmProvider.java @@ -114,7 +114,7 @@ public abstract class CsdlAbstractEdmProvider implements CsdlEdmProvider { } @Override - public CsdlAnnotatable getAnnoatatable(final FullQualifiedName annotatedName) throws ODataException { + public CsdlAnnotatable getAnnotatable(final FullQualifiedName annotatedName) throws ODataException { return null; } } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAction.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAction.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAction.java index 9b56462..5c1ad19 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAction.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAction.java @@ -51,6 +51,7 @@ public class CsdlAction extends CsdlOperation { return this; } + @Override public CsdlAction setReturnType(final CsdlReturnType returnType) { this.returnType = returnType; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlActionImport.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlActionImport.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlActionImport.java index 1b22d16..33047de 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlActionImport.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlActionImport.java @@ -40,7 +40,7 @@ public class CsdlActionImport extends CsdlOperationImport { this.entitySet = entitySet; return this; } - + /** * Returns the full qualified name of the action as string * @return full qualified name @@ -48,7 +48,7 @@ public class CsdlActionImport extends CsdlOperationImport { public String getAction() { return action.getFullQualifiedNameAsString(); } - + /** * Returns the full qualified name of the action * @return full qualified name @@ -56,7 +56,7 @@ public class CsdlActionImport extends CsdlOperationImport { public FullQualifiedName getActionFQN() { return action; } - + /** * Sets the full qualified name of the action as string * @param action full qualified name http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAliasInfo.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAliasInfo.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAliasInfo.java index f89dc4c..d53ff82 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAliasInfo.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAliasInfo.java @@ -37,22 +37,22 @@ public class CsdlAliasInfo { /** * Sets the namespace of the alias - * @param namespace + * @param namespace the namespace of the alias * @return this instance */ public CsdlAliasInfo setNamespace(final String namespace) { this.namespace = namespace; return this; } - + /** * Returns the alias of item - * @return Alias + * @return Alias alias */ public String getAlias() { return alias; } - + /** * Sets the alias of the item * @param alias Alias http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotatable.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotatable.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotatable.java index 66387fb..c434d53 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotatable.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotatable.java @@ -24,7 +24,7 @@ import java.util.List; * Super type of all annotatable CSDL items */ public interface CsdlAnnotatable { - + /** * Returns a list of annotations * @return list of annotations http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotation.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotation.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotation.java index 8ef3d73..60354ca 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotation.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotation.java @@ -37,7 +37,7 @@ public class CsdlAnnotation extends CsdlAbstractEdmItem implements CsdlAnnotatab private List<CsdlAnnotation> annotation = new ArrayList<CsdlAnnotation>(); private AnnotationExpression annotationExpression; - + /** * Returns the annotated expression * @return expression annotated expression @@ -45,23 +45,23 @@ public class CsdlAnnotation extends CsdlAbstractEdmItem implements CsdlAnnotatab public AnnotationExpression getExpression() { return annotationExpression; } - + /** * Sets the annotated expression - * @param annotationExpression annotated expression + * @param annotationExpression annotated expression */ public void setExpression(final AnnotationExpression annotationExpression) { this.annotationExpression = annotationExpression; } - + /** * Returns the annotated term - * @return Term + * @return Term term */ public String getTerm() { return term; } - + /** * Sets the annotated expression * @param term term @@ -71,7 +71,7 @@ public class CsdlAnnotation extends CsdlAbstractEdmItem implements CsdlAnnotatab this.term = term; return this; } - + /** * Returns the annotated qualifier * @return annotated qualifier @@ -79,7 +79,7 @@ public class CsdlAnnotation extends CsdlAbstractEdmItem implements CsdlAnnotatab public String getQualifier() { return qualifier; } - + /** * Sets the annotated qualifier * @param qualifier annotated qualifier @@ -89,7 +89,7 @@ public class CsdlAnnotation extends CsdlAbstractEdmItem implements CsdlAnnotatab this.qualifier = qualifier; return this; } - + /** * Sets a list of annotations * @param annotation list of annotations http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotations.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotations.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotations.java index 59daf18..7d4c4c1 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotations.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlAnnotations.java @@ -21,6 +21,9 @@ package org.apache.olingo.commons.api.edm.provider; import java.util.ArrayList; import java.util.List; +/** + * The type Csdl annotations. + */ public class CsdlAnnotations extends CsdlAbstractEdmItem implements CsdlAnnotatable { private static final long serialVersionUID = 8283036066408166150L; @@ -31,19 +34,41 @@ public class CsdlAnnotations extends CsdlAbstractEdmItem implements CsdlAnnotata private String qualifier; + /** + * Gets target. + * + * @return the target + */ public String getTarget() { return target; } + /** + * Sets target. + * + * @param target the target + * @return the target + */ public CsdlAnnotations setTarget(final String target) { this.target = target; return this; } + /** + * Gets qualifier. + * + * @return the qualifier + */ public String getQualifier() { return qualifier; } + /** + * Sets qualifier. + * + * @param qualifier the qualifier + * @return the qualifier + */ public CsdlAnnotations setQualifier(final String qualifier) { this.qualifier = qualifier; return this; @@ -54,6 +79,12 @@ public class CsdlAnnotations extends CsdlAbstractEdmItem implements CsdlAnnotata return annotations; } + /** + * Gets annotation. + * + * @param term the term + * @return the annotation + */ public CsdlAnnotation getAnnotation(final String term) { CsdlAnnotation result = null; for (CsdlAnnotation annotation : getAnnotations()) { http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlBindingTarget.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlBindingTarget.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlBindingTarget.java index 1c79faf..2c8a0d3 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlBindingTarget.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlBindingTarget.java @@ -23,14 +23,26 @@ import java.util.List; import org.apache.olingo.commons.api.edm.FullQualifiedName; +/** + * The type Csdl binding target. + */ public abstract class CsdlBindingTarget extends CsdlAbstractEdmItem implements CsdlNamed, CsdlAnnotatable { private static final long serialVersionUID = -7011724617956042182L; + /** + * The Name. + */ protected String name; + /** + * The Type. + */ protected FullQualifiedName type; + /** + * The Navigation property bindings. + */ protected List<CsdlNavigationPropertyBinding> navigationPropertyBindings = new ArrayList<CsdlNavigationPropertyBinding>(); @@ -41,33 +53,72 @@ public abstract class CsdlBindingTarget extends CsdlAbstractEdmItem implements C return name; } + /** + * Sets name. + * + * @param name the name + * @return the name + */ public CsdlBindingTarget setName(final String name) { this.name = name; return this; } + /** + * Gets type. + * + * @return the type + */ public String getType() { return type.getFullQualifiedNameAsString(); } + /** + * Gets type fQN. + * + * @return the type fQN + */ public FullQualifiedName getTypeFQN() { return type; } + /** + * Sets type. + * + * @param type the type + * @return the type + */ public CsdlBindingTarget setType(final String type) { this.type = new FullQualifiedName(type); return this; } + /** + * Sets type. + * + * @param type the type + * @return the type + */ public CsdlBindingTarget setType(final FullQualifiedName type) { this.type = type; return this; } + /** + * Gets navigation property bindings. + * + * @return the navigation property bindings + */ public List<CsdlNavigationPropertyBinding> getNavigationPropertyBindings() { return navigationPropertyBindings; } + /** + * Sets navigation property bindings. + * + * @param navigationPropertyBindings the navigation property bindings + * @return the navigation property bindings + */ public CsdlBindingTarget setNavigationPropertyBindings( final List<CsdlNavigationPropertyBinding> navigationPropertyBindings) { this.navigationPropertyBindings = navigationPropertyBindings; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlComplexType.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlComplexType.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlComplexType.java index cb3f123..7635d57 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlComplexType.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlComplexType.java @@ -22,6 +22,9 @@ import java.util.List; import org.apache.olingo.commons.api.edm.FullQualifiedName; +/** + * The type Csdl complex type. + */ public class CsdlComplexType extends CsdlStructuralType { private static final long serialVersionUID = 1089771609327713928L; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEdmProvider.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEdmProvider.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEdmProvider.java index 61be99c..8d6cdae 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEdmProvider.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEdmProvider.java @@ -23,157 +23,169 @@ import java.util.List; import org.apache.olingo.commons.api.ex.ODataException; import org.apache.olingo.commons.api.edm.FullQualifiedName; -public interface CsdlEdmProvider { +/** + * The interface Csdl edm provider. + */ +interface CsdlEdmProvider { /** * This method should return an {@link CsdlEnumType} or <b>null</b> if nothing is found * - * @param enumTypeName - * @return {@link CsdlEnumType} for given name - * @throws ODataException + * @param enumTypeName full qualified name of enum type + * @return for given name + * @throws ODataException the o data exception */ - public CsdlEnumType getEnumType(final FullQualifiedName enumTypeName) throws ODataException; + CsdlEnumType getEnumType(final FullQualifiedName enumTypeName) throws ODataException; /** * This method should return an {@link CsdlTypeDefinition} or <b>null</b> if nothing is found * - * @param typeDefinitionName - * @return {@link CsdlTypeDefinition} for given name - * @throws ODataException + * @param typeDefinitionName full qualified name of type definition + * @return for given name + * @throws ODataException the o data exception */ - public CsdlTypeDefinition getTypeDefinition(final FullQualifiedName typeDefinitionName) throws ODataException; + CsdlTypeDefinition getTypeDefinition(final FullQualifiedName typeDefinitionName) throws ODataException; /** * This method should return an {@link CsdlEntityType} or <b>null</b> if nothing is found * - * @param entityTypeName - * @return {@link CsdlEntityType} for the given name - * @throws ODataException + * @param entityTypeName full qualified name of entity type + * @return for the given name + * @throws ODataException the o data exception */ - public CsdlEntityType getEntityType(final FullQualifiedName entityTypeName) throws ODataException; + CsdlEntityType getEntityType(final FullQualifiedName entityTypeName) throws ODataException; /** * This method should return a {@link CsdlComplexType} or <b>null</b> if nothing is found. * - * @param complexTypeName - * @return {@link CsdlComplexType} for the given name - * @throws ODataException + * @param complexTypeName full qualified name of complex type + * @return for the given name + * @throws ODataException the o data exception */ - public CsdlComplexType getComplexType(final FullQualifiedName complexTypeName) throws ODataException; + CsdlComplexType getComplexType(final FullQualifiedName complexTypeName) throws ODataException; /** * This method should return a list of all {@link CsdlAction} for the FullQualifiedname * or <b>null</b> if nothing is found * - * @param actionName - * @return List of {@link CsdlAction} or null - * @throws ODataException + * @param actionName full qualified name of action + * @return List of + * or null + * @throws ODataException the o data exception */ - public List<CsdlAction> getActions(final FullQualifiedName actionName) throws ODataException; + List<CsdlAction> getActions(final FullQualifiedName actionName) throws ODataException; /** * This method should return a list of all {@link CsdlFunction} for the FullQualifiedname or <b>null</b> if nothing is * found * - * @param functionName - * @return List of {@link CsdlFunction} or null - * @throws ODataException + * @param functionName full qualified name of function + * @return List of + * or null + * @throws ODataException the o data exception */ - public List<CsdlFunction> getFunctions(final FullQualifiedName functionName) throws ODataException; + List<CsdlFunction> getFunctions(final FullQualifiedName functionName) throws ODataException; /** * This method should return a {@link CsdlTerm} for the FullQualifiedName or <b>null</b> if nothing is found. * @param termName the name of the Term - * @return {@link CsdlTerm} or null - * @throws ODataException + * @return or null + * @throws ODataException the o data exception */ - public CsdlTerm getTerm(final FullQualifiedName termName) throws ODataException; + CsdlTerm getTerm(final FullQualifiedName termName) throws ODataException; /** * This method should return an {@link CsdlEntitySet} or <b>null</b> if nothing is found * * @param entityContainer this EntitySet is contained in - * @param entitySetName - * @return {@link CsdlEntitySet} for the given container and entityset name - * @throws ODataException + * @param entitySetName name of entity set + * @return for the given container and entityset name + * @throws ODataException the o data exception */ - public CsdlEntitySet getEntitySet(final FullQualifiedName entityContainer, final String entitySetName) + CsdlEntitySet getEntitySet(final FullQualifiedName entityContainer, final String entitySetName) throws ODataException; /** * This method should return an {@link CsdlSingleton} or <b>null</b> if nothing is found * * @param entityContainer this Singleton is contained in - * @param singletonName - * @return {@link CsdlSingleton} for given container and singleton name - * @throws ODataException + * @param singletonName name of singleton + * @return for given container and singleton name + * @throws ODataException the o data exception */ - public CsdlSingleton getSingleton(final FullQualifiedName entityContainer, final String singletonName) + CsdlSingleton getSingleton(final FullQualifiedName entityContainer, final String singletonName) throws ODataException; /** * This method should return an {@link CsdlActionImport} or <b>null</b> if nothing is found * * @param entityContainer this ActionImport is contained in - * @param actionImportName - * @return {@link CsdlActionImport} for the given container and ActionImport name - * @throws ODataException + * @param actionImportName name of action import + * @return for the given container and ActionImport name + * @throws ODataException the o data exception */ - public CsdlActionImport getActionImport(final FullQualifiedName entityContainer, final String actionImportName) + CsdlActionImport getActionImport(final FullQualifiedName entityContainer, final String actionImportName) throws ODataException; /** * This method should return a {@link CsdlFunctionImport} or <b>null</b> if nothing is found * * @param entityContainer this FunctionImport is contained in - * @param functionImportName - * @return {@link CsdlFunctionImport} for the given container name and function import name - * @throws ODataException + * @param functionImportName name of function import + * @return for the given container name and function import name + * @throws ODataException the o data exception */ - public CsdlFunctionImport getFunctionImport(final FullQualifiedName entityContainer, final String functionImportName) + CsdlFunctionImport getFunctionImport(final FullQualifiedName entityContainer, final String functionImportName) throws ODataException; /** * This method should return an {@link CsdlEntityContainerInfo} or <b>null</b> if nothing is found * * @param entityContainerName (null for default container) - * @return {@link CsdlEntityContainerInfo} for the given name - * @throws ODataException + * @return for the given name + * @throws ODataException the o data exception */ - public CsdlEntityContainerInfo getEntityContainerInfo(final FullQualifiedName entityContainerName) + CsdlEntityContainerInfo getEntityContainerInfo(final FullQualifiedName entityContainerName) throws ODataException; /** * This method should return a list of all namespaces which have an alias * * @return List of alias info - * @throws ODataException + * @throws ODataException the o data exception */ - public List<CsdlAliasInfo> getAliasInfos() throws ODataException; + List<CsdlAliasInfo> getAliasInfos() throws ODataException; /** * This method should return a collection of all {@link CsdlSchema} * - * @return List<{@link CsdlSchema}> - * @throws ODataException + * @return List of + * @throws ODataException the o data exception */ - public List<CsdlSchema> getSchemas() throws ODataException; + List<CsdlSchema> getSchemas() throws ODataException; /** * Returns the entity container of this edm - * @return {@link CsdlEntityContainer} of this edm + * @return of this edm + * @throws ODataException the o data exception */ - public CsdlEntityContainer getEntityContainer() throws ODataException; + CsdlEntityContainer getEntityContainer() throws ODataException; /** - * @param targetName - * @return {@link CsdlAnnotations} group for the given Target + * Gets annotations group. + * + * @param targetName full qualified name of target + * @return group for the given Target + * @throws ODataException the o data exception */ - public CsdlAnnotations getAnnotationsGroup(FullQualifiedName targetName) throws ODataException; + CsdlAnnotations getAnnotationsGroup(FullQualifiedName targetName) throws ODataException; /** - * @param annotatedName - * @return Annotatble element by target name + * Gets annotatable. + * + * @param annotatedName full qualified name of annotatable + * @return Annotatable element by target name + * @throws ODataException the o data exception */ - public CsdlAnnotatable getAnnoatatable(FullQualifiedName annotatedName) throws ODataException; + CsdlAnnotatable getAnnotatable(FullQualifiedName annotatedName) throws ODataException; } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityContainer.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityContainer.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityContainer.java index 2ce9391..5cb13c8 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityContainer.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityContainer.java @@ -23,6 +23,9 @@ import java.util.List; import org.apache.olingo.commons.api.edm.FullQualifiedName; +/** + * The type Csdl entity container. + */ public class CsdlEntityContainer extends CsdlAbstractEdmItem implements CsdlNamed, CsdlAnnotatable { private static final long serialVersionUID = 5384682515007129458L; @@ -47,11 +50,22 @@ public class CsdlEntityContainer extends CsdlAbstractEdmItem implements CsdlName return name; } + /** + * Sets name. + * + * @param name the name + * @return the name + */ public CsdlEntityContainer setName(final String name) { this.name = name; return this; } + /** + * Gets extends container. + * + * @return the extends container + */ public String getExtendsContainer() { if (extendsContainer != null) { return extendsContainer.getFullQualifiedNameAsString(); @@ -59,28 +73,61 @@ public class CsdlEntityContainer extends CsdlAbstractEdmItem implements CsdlName return null; } + /** + * Gets extends container fQN. + * + * @return the extends container fQN + */ public FullQualifiedName getExtendsContainerFQN() { return extendsContainer; } + /** + * Sets extends container. + * + * @param extendsContainer the extends container + * @return the extends container + */ public CsdlEntityContainer setExtendsContainer(final String extendsContainer) { this.extendsContainer = new FullQualifiedName(extendsContainer); return this; } + /** + * Gets entity sets. + * + * @return the entity sets + */ public List<CsdlEntitySet> getEntitySets() { return entitySets; } + /** + * Gets entity set. + * + * @param name the name + * @return the entity set + */ public CsdlEntitySet getEntitySet(final String name) { return getOneByName(name, getEntitySets()); } + /** + * Sets entity sets. + * + * @param entitySets the entity sets + * @return the entity sets + */ public CsdlEntityContainer setEntitySets(final List<CsdlEntitySet> entitySets) { this.entitySets = entitySets; return this; } + /** + * Gets action imports. + * + * @return the action imports + */ public List<CsdlActionImport> getActionImports() { return actionImports; } @@ -105,11 +152,22 @@ public class CsdlEntityContainer extends CsdlAbstractEdmItem implements CsdlName return getAllByName(name, getActionImports()); } + /** + * Sets action imports. + * + * @param actionImports the action imports + * @return the action imports + */ public CsdlEntityContainer setActionImports(final List<CsdlActionImport> actionImports) { this.actionImports = actionImports; return this; } + /** + * Gets function imports. + * + * @return the function imports + */ public List<CsdlFunctionImport> getFunctionImports() { return functionImports; } @@ -134,19 +192,42 @@ public class CsdlEntityContainer extends CsdlAbstractEdmItem implements CsdlName return getAllByName(name, getFunctionImports()); } + /** + * Sets function imports. + * + * @param functionImports the function imports + * @return the function imports + */ public CsdlEntityContainer setFunctionImports(final List<CsdlFunctionImport> functionImports) { this.functionImports = functionImports; return this; } + /** + * Gets singletons. + * + * @return the singletons + */ public List<CsdlSingleton> getSingletons() { return singletons; } + /** + * Gets singleton. + * + * @param name the name + * @return the singleton + */ public CsdlSingleton getSingleton(final String name) { return getOneByName(name, getSingletons()); } + /** + * Sets singletons. + * + * @param singletons the singletons + * @return the singletons + */ public CsdlEntityContainer setSingletons(final List<CsdlSingleton> singletons) { this.singletons = singletons; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityContainerInfo.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityContainerInfo.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityContainerInfo.java index 757d100..a576e8f 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityContainerInfo.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityContainerInfo.java @@ -20,25 +20,50 @@ package org.apache.olingo.commons.api.edm.provider; import org.apache.olingo.commons.api.edm.FullQualifiedName; +/** + * The type Csdl entity container info. + */ public class CsdlEntityContainerInfo { private FullQualifiedName containerName; private FullQualifiedName extendsContainer; + /** + * Gets container name. + * + * @return the container name + */ public FullQualifiedName getContainerName() { return containerName; } + /** + * Sets container name. + * + * @param containerName the container name + * @return the container name + */ public CsdlEntityContainerInfo setContainerName(final FullQualifiedName containerName) { this.containerName = containerName; return this; } + /** + * Gets extends container. + * + * @return the extends container + */ public FullQualifiedName getExtendsContainer() { return extendsContainer; } + /** + * Sets extends container. + * + * @param extendsContainer the extends container + * @return the extends container + */ public CsdlEntityContainerInfo setExtendsContainer(final FullQualifiedName extendsContainer) { this.extendsContainer = extendsContainer; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntitySet.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntitySet.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntitySet.java index 3399f28..3ba2c38 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntitySet.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntitySet.java @@ -22,6 +22,9 @@ import java.util.List; import org.apache.olingo.commons.api.edm.FullQualifiedName; +/** + * The type Csdl entity set. + */ public class CsdlEntitySet extends CsdlBindingTarget { private static final long serialVersionUID = 5291570018480936643L; @@ -54,10 +57,21 @@ public class CsdlEntitySet extends CsdlBindingTarget { return this; } + /** + * Is include in service document. + * + * @return the boolean + */ public boolean isIncludeInServiceDocument() { return includeInServiceDocument; } + /** + * Sets include in service document. + * + * @param includeInServiceDocument the include in service document + * @return the include in service document + */ public CsdlEntitySet setIncludeInServiceDocument(final boolean includeInServiceDocument) { this.includeInServiceDocument = includeInServiceDocument; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntitySetPath.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntitySetPath.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntitySetPath.java index 446c636..4813ca8 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntitySetPath.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntitySetPath.java @@ -18,25 +18,50 @@ */ package org.apache.olingo.commons.api.edm.provider; +/** + * The type Csdl entity set path. + */ public class CsdlEntitySetPath { private String bindingParameter; private String path; + /** + * Gets binding parameter. + * + * @return the binding parameter + */ public String getBindingParameter() { return bindingParameter; } + /** + * Sets binding parameter. + * + * @param bindingParameter the binding parameter + * @return the binding parameter + */ public CsdlEntitySetPath setBindingParameter(final String bindingParameter) { this.bindingParameter = bindingParameter; return this; } + /** + * Gets path. + * + * @return the path + */ public String getPath() { return path; } + /** + * Sets path. + * + * @param path the path + * @return the path + */ public CsdlEntitySetPath setPath(final String path) { this.path = path; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityType.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityType.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityType.java index 92f9c3c..25ed899 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityType.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEntityType.java @@ -22,6 +22,9 @@ import java.util.List; import org.apache.olingo.commons.api.edm.FullQualifiedName; +/** + * The type Csdl entity type. + */ public class CsdlEntityType extends CsdlStructuralType { private static final long serialVersionUID = -1564752618679704024L; @@ -30,19 +33,41 @@ public class CsdlEntityType extends CsdlStructuralType { private boolean hasStream = false; + /** + * Has stream. + * + * @return the boolean + */ public boolean hasStream() { return hasStream; } + /** + * Sets has stream. + * + * @param hasStream the has stream + * @return the has stream + */ public CsdlEntityType setHasStream(final boolean hasStream) { this.hasStream = hasStream; return this; } + /** + * Gets key. + * + * @return the key + */ public List<CsdlPropertyRef> getKey() { return key; } + /** + * Sets key. + * + * @param key the key + * @return the key + */ public CsdlEntityType setKey(final List<CsdlPropertyRef> key) { this.key = key; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEnumMember.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEnumMember.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEnumMember.java index 2ab5ec9..ba8a82d 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEnumMember.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEnumMember.java @@ -21,6 +21,9 @@ package org.apache.olingo.commons.api.edm.provider; import java.util.ArrayList; import java.util.List; +/** + * The type Csdl enum member. + */ public class CsdlEnumMember extends CsdlAbstractEdmItem implements CsdlNamed, CsdlAnnotatable { private static final long serialVersionUID = 5618984420582832094L; @@ -36,15 +39,32 @@ public class CsdlEnumMember extends CsdlAbstractEdmItem implements CsdlNamed, Cs return name; } + /** + * Sets name. + * + * @param name the name + * @return the name + */ public CsdlEnumMember setName(final String name) { this.name = name; return this; } + /** + * Gets value. + * + * @return the value + */ public String getValue() { return value; } + /** + * Sets value. + * + * @param value the value + * @return the value + */ public CsdlEnumMember setValue(final String value) { this.value = value; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEnumType.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEnumType.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEnumType.java index 9f0f693..88c2f93 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEnumType.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlEnumType.java @@ -23,6 +23,9 @@ import java.util.List; import org.apache.olingo.commons.api.edm.FullQualifiedName; +/** + * The type Csdl enum type. + */ public class CsdlEnumType extends CsdlAbstractEdmItem implements CsdlNamed, CsdlAnnotatable { private static final long serialVersionUID = -718032622783883403L; @@ -42,20 +45,42 @@ public class CsdlEnumType extends CsdlAbstractEdmItem implements CsdlNamed, Csdl return name; } + /** + * Sets name. + * + * @param name the name + * @return the name + */ public CsdlEnumType setName(final String name) { this.name = name; return this; } + /** + * Is flags. + * + * @return the boolean + */ public boolean isFlags() { return isFlags; } + /** + * Sets flags. + * + * @param isFlags the is flags + * @return the flags + */ public CsdlEnumType setFlags(final boolean isFlags) { this.isFlags = isFlags; return this; } + /** + * Gets underlying type. + * + * @return the underlying type + */ public String getUnderlyingType() { if (underlyingType != null) { return underlyingType.getFullQualifiedNameAsString(); @@ -63,20 +88,43 @@ public class CsdlEnumType extends CsdlAbstractEdmItem implements CsdlNamed, Csdl return null; } + /** + * Sets underlying type. + * + * @param underlyingType the underlying type + * @return the underlying type + */ public CsdlEnumType setUnderlyingType(final String underlyingType) { this.underlyingType = new FullQualifiedName(underlyingType); return this; } + /** + * Sets underlying type. + * + * @param underlyingType the underlying type + * @return the underlying type + */ public CsdlEnumType setUnderlyingType(final FullQualifiedName underlyingType) { this.underlyingType = underlyingType; return this; } + /** + * Gets members. + * + * @return the members + */ public List<CsdlEnumMember> getMembers() { return members; } + /** + * Gets member. + * + * @param name the name + * @return the member + */ public CsdlEnumMember getMember(final String name) { CsdlEnumMember result = null; if (getMembers() != null) { @@ -89,6 +137,12 @@ public class CsdlEnumType extends CsdlAbstractEdmItem implements CsdlNamed, Csdl return result; } + /** + * Gets member. + * + * @param value the value + * @return the member + */ public CsdlEnumMember getMember(final Integer value) { CsdlEnumMember result = null; if (getMembers() != null) { @@ -101,6 +155,12 @@ public class CsdlEnumType extends CsdlAbstractEdmItem implements CsdlNamed, Csdl return result; } + /** + * Sets members. + * + * @param members the members + * @return the members + */ public CsdlEnumType setMembers(final List<CsdlEnumMember> members) { this.members = members; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlExpression.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlExpression.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlExpression.java index f603062..f555343 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlExpression.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlExpression.java @@ -18,6 +18,9 @@ */ package org.apache.olingo.commons.api.edm.provider; +/** + * The type Csdl expression. + */ public class CsdlExpression { // TODO: Expression implementation } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlFunction.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlFunction.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlFunction.java index 7ddfad3..e9c22fe 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlFunction.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlFunction.java @@ -20,16 +20,30 @@ package org.apache.olingo.commons.api.edm.provider; import java.util.List; +/** + * The type Csdl function. + */ public class CsdlFunction extends CsdlOperation { private static final long serialVersionUID = 673858921468578957L; private boolean isComposable = false; + /** + * Is composable. + * + * @return the boolean + */ public boolean isComposable() { return isComposable; } + /** + * Sets composable. + * + * @param isComposable the is composable + * @return the composable + */ public CsdlFunction setComposable(final boolean isComposable) { this.isComposable = isComposable; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlFunctionImport.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlFunctionImport.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlFunctionImport.java index a1c0004..9b6f534 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlFunctionImport.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlFunctionImport.java @@ -20,6 +20,9 @@ package org.apache.olingo.commons.api.edm.provider; import org.apache.olingo.commons.api.edm.FullQualifiedName; +/** + * The type Csdl function import. + */ public class CsdlFunctionImport extends CsdlOperationImport { private static final long serialVersionUID = 8479762299534736719L; @@ -46,28 +49,61 @@ public class CsdlFunctionImport extends CsdlOperationImport { return this; } + /** + * Gets function. + * + * @return the function + */ public String getFunction() { return function.getFullQualifiedNameAsString(); } + /** + * Gets function fQN. + * + * @return the function fQN + */ public FullQualifiedName getFunctionFQN() { return function; } + /** + * Sets function. + * + * @param function the function + * @return the function + */ public CsdlFunctionImport setFunction(final FullQualifiedName function) { this.function = function; return this; } + /** + * Sets function. + * + * @param function the function + * @return the function + */ public CsdlFunctionImport setFunction(final String function) { this.function = new FullQualifiedName(function); return this; } + /** + * Is include in service document. + * + * @return the boolean + */ public boolean isIncludeInServiceDocument() { return includeInServiceDocument; } + /** + * Sets include in service document. + * + * @param includeInServiceDocument the include in service document + * @return the include in service document + */ public CsdlFunctionImport setIncludeInServiceDocument(final boolean includeInServiceDocument) { this.includeInServiceDocument = includeInServiceDocument; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNamed.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNamed.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNamed.java index f82edc2..fc95f36 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNamed.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNamed.java @@ -18,8 +18,15 @@ */ package org.apache.olingo.commons.api.edm.provider; - +/** + * The interface Csdl named. + */ public interface CsdlNamed { + /** + * Gets name. + * + * @return the name + */ String getName(); } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNavigationProperty.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNavigationProperty.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNavigationProperty.java index e1ed7e6..37e4de1 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNavigationProperty.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNavigationProperty.java @@ -23,6 +23,9 @@ import java.util.List; import org.apache.olingo.commons.api.edm.FullQualifiedName; +/** + * The type Csdl navigation property. + */ public class CsdlNavigationProperty extends CsdlAbstractEdmItem implements CsdlNamed, CsdlAnnotatable { private static final long serialVersionUID = -788021920718310799L; @@ -51,24 +54,51 @@ public class CsdlNavigationProperty extends CsdlAbstractEdmItem implements CsdlN return name; } + /** + * Is collection. + * + * @return the boolean + */ public boolean isCollection() { return isCollection; } + /** + * Sets collection. + * + * @param isCollection the is collection + * @return the collection + */ public CsdlNavigationProperty setCollection(final boolean isCollection) { this.isCollection = isCollection; return this; } + /** + * Sets name. + * + * @param name the name + * @return the name + */ public CsdlNavigationProperty setName(final String name) { this.name = name; return this; } + /** + * Gets type fQN. + * + * @return the type fQN + */ public FullQualifiedName getTypeFQN() { return type; } + /** + * Gets type. + * + * @return the type + */ public String getType() { if (type != null) { return type.getFullQualifiedNameAsString(); @@ -76,57 +106,124 @@ public class CsdlNavigationProperty extends CsdlAbstractEdmItem implements CsdlN return null; } + /** + * Sets type. + * + * @param type the type + * @return the type + */ public CsdlNavigationProperty setType(final FullQualifiedName type) { this.type = type; return this; } + /** + * Sets type. + * + * @param type the type + * @return the type + */ public CsdlNavigationProperty setType(final String type) { this.type = new FullQualifiedName(type); return this; } + /** + * Gets partner. + * + * @return the partner + */ public String getPartner() { return partner; } + /** + * Sets partner. + * + * @param partner the partner + * @return the partner + */ public CsdlNavigationProperty setPartner(final String partner) { this.partner = partner; return this; } + /** + * Is contains target. + * + * @return the boolean + */ public boolean isContainsTarget() { return containsTarget; } + /** + * Sets contains target. + * + * @param containsTarget the contains target + * @return the contains target + */ public CsdlNavigationProperty setContainsTarget(final boolean containsTarget) { this.containsTarget = containsTarget; return this; } + /** + * Gets referential constraints. + * + * @return the referential constraints + */ public List<CsdlReferentialConstraint> getReferentialConstraints() { return referentialConstraints; } + /** + * Sets referential constraints. + * + * @param referentialConstraints the referential constraints + * @return the referential constraints + */ public CsdlNavigationProperty setReferentialConstraints( final List<CsdlReferentialConstraint> referentialConstraints) { this.referentialConstraints = referentialConstraints; return this; } + /** + * Is nullable. + * + * @return the boolean + */ public Boolean isNullable() { return nullable; } + /** + * Sets nullable. + * + * @param nullable the nullable + * @return the nullable + */ public CsdlNavigationProperty setNullable(final Boolean nullable) { this.nullable = nullable; return this; } + /** + * Gets on delete. + * + * @return the on delete + */ public CsdlOnDelete getOnDelete() { return onDelete; } + /** + * Sets on delete. + * + * @param onDelete the on delete + * @return the on delete + */ public CsdlNavigationProperty setOnDelete(final CsdlOnDelete onDelete) { this.onDelete = onDelete; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNavigationPropertyBinding.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNavigationPropertyBinding.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNavigationPropertyBinding.java index 9c4d16c..9169ae4 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNavigationPropertyBinding.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlNavigationPropertyBinding.java @@ -18,6 +18,9 @@ */ package org.apache.olingo.commons.api.edm.provider; +/** + * The type Csdl navigation property binding. + */ public class CsdlNavigationPropertyBinding extends CsdlAbstractEdmItem { private static final long serialVersionUID = 770380971233808502L; @@ -26,19 +29,41 @@ public class CsdlNavigationPropertyBinding extends CsdlAbstractEdmItem { private String target; + /** + * Gets path. + * + * @return the path + */ public String getPath() { return path; } + /** + * Sets path. + * + * @param path the path + * @return the path + */ public CsdlNavigationPropertyBinding setPath(final String path) { this.path = path; return this; } + /** + * Gets target. + * + * @return the target + */ public String getTarget() { return target; } + /** + * Sets target. + * + * @param target the target + * @return the target + */ public CsdlNavigationPropertyBinding setTarget(final String target) { this.target = target; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOnDelete.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOnDelete.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOnDelete.java index 3a3aa85..3b5b746 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOnDelete.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOnDelete.java @@ -18,16 +18,30 @@ */ package org.apache.olingo.commons.api.edm.provider; +/** + * The type Csdl on delete. + */ public class CsdlOnDelete extends CsdlAbstractEdmItem { private static final long serialVersionUID = -7130889202653716784L; private CsdlOnDeleteAction action = CsdlOnDeleteAction.None; + /** + * Gets action. + * + * @return the action + */ public CsdlOnDeleteAction getAction() { return action; } + /** + * Sets action. + * + * @param action the action + * @return the action + */ public CsdlOnDelete setAction(final CsdlOnDeleteAction action) { this.action = action; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOnDeleteAction.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOnDeleteAction.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOnDeleteAction.java index 24aec9ed..9a7f8ed 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOnDeleteAction.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOnDeleteAction.java @@ -18,11 +18,25 @@ */ package org.apache.olingo.commons.api.edm.provider; +/** + * The enum Csdl on delete action. + */ public enum CsdlOnDeleteAction { + /** + * The Cascade. + */ Cascade, + /** + * The None. + */ None, + /** + * The SetNull. + */ SetNull, + /** + * The SetDefault. + */ SetDefault - } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOperation.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOperation.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOperation.java index 695bfa5..79acae1 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOperation.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOperation.java @@ -21,20 +21,41 @@ package org.apache.olingo.commons.api.edm.provider; import java.util.ArrayList; import java.util.List; +/** + * The type Csdl operation. + */ public abstract class CsdlOperation extends CsdlAbstractEdmItem implements CsdlNamed, CsdlAnnotatable { private static final long serialVersionUID = -3842411084067064086L; + /** + * The Name. + */ protected String name; + /** + * The Is bound. + */ protected boolean isBound = false; + /** + * The Entity set path. + */ protected String entitySetPath; + /** + * The Parameters. + */ protected List<CsdlParameter> parameters = new ArrayList<CsdlParameter>(); + /** + * The Return type. + */ protected CsdlReturnType returnType; + /** + * The Annotations. + */ protected final List<CsdlAnnotation> annotations = new ArrayList<CsdlAnnotation>(); @Override @@ -42,46 +63,102 @@ public abstract class CsdlOperation extends CsdlAbstractEdmItem implements CsdlN return name; } + /** + * Sets name. + * + * @param name the name + * @return the name + */ public CsdlOperation setName(final String name) { this.name = name; return this; } + /** + * Is bound. + * + * @return the boolean + */ public boolean isBound() { return isBound; } + /** + * Sets as bound operation. + * + * @param isBound the is bound + * @return the bound + */ public CsdlOperation setBound(final boolean isBound) { this.isBound = isBound; return this; } + /** + * Gets entity set path. + * + * @return the entity set path + */ public String getEntitySetPath() { return entitySetPath; } + /** + * Sets entity set path. + * + * @param entitySetPath the entity set path + * @return the entity set path + */ public CsdlOperation setEntitySetPath(final String entitySetPath) { this.entitySetPath = entitySetPath; return this; } + /** + * Gets parameters. + * + * @return the parameters + */ public List<CsdlParameter> getParameters() { return parameters; } + /** + * Gets parameter. + * + * @param name the name + * @return the parameter + */ public CsdlParameter getParameter(final String name) { return getOneByName(name, getParameters()); } + /** + * Sets parameters. + * + * @param parameters the parameters + * @return the parameters + */ public CsdlOperation setParameters(final List<CsdlParameter> parameters) { this.parameters = parameters; return this; } + /** + * Gets return type. + * + * @return the return type + */ public CsdlReturnType getReturnType() { return returnType; } + /** + * Sets return type. + * + * @param returnType the return type + * @return the return type + */ public CsdlOperation setReturnType(final CsdlReturnType returnType) { this.returnType = returnType; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOperationImport.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOperationImport.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOperationImport.java index 37c7ae4..d43417c 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOperationImport.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlOperationImport.java @@ -21,12 +21,24 @@ package org.apache.olingo.commons.api.edm.provider; import java.util.ArrayList; import java.util.List; +/** + * The type Csdl operation import. + */ public abstract class CsdlOperationImport extends CsdlAbstractEdmItem implements CsdlNamed, CsdlAnnotatable { private static final long serialVersionUID = -8928186067970681061L; + /** + * The Name. + */ protected String name; + /** + * The Entity set. + */ protected String entitySet; + /** + * The Annotations. + */ protected final List<CsdlAnnotation> annotations = new ArrayList<CsdlAnnotation>(); @Override @@ -34,15 +46,32 @@ public abstract class CsdlOperationImport extends CsdlAbstractEdmItem implements return name; } + /** + * Sets name. + * + * @param name the name + * @return the name + */ public CsdlOperationImport setName(final String name) { this.name = name; return this; } + /** + * Gets entity set. + * + * @return the entity set + */ public String getEntitySet() { return entitySet; } + /** + * Sets entity set. + * + * @param entitySet the entity set + * @return the entity set + */ public CsdlOperationImport setEntitySet(final String entitySet) { this.entitySet = entitySet; return this; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/9ffe4c89/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlParameter.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlParameter.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlParameter.java index c4fadb2..4f5f0c7 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlParameter.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/CsdlParameter.java @@ -24,6 +24,9 @@ import java.util.List; import org.apache.olingo.commons.api.edm.FullQualifiedName; import org.apache.olingo.commons.api.edm.geo.SRID; +/** + * The type Csdl parameter. + */ public class CsdlParameter extends CsdlAbstractEdmItem implements CsdlNamed, CsdlAnnotatable { private static final long serialVersionUID = -7360900923880732015L; @@ -54,78 +57,172 @@ public class CsdlParameter extends CsdlAbstractEdmItem implements CsdlNamed, Csd return name; } + /** + * Sets name. + * + * @param name the name + * @return the name + */ public CsdlParameter setName(final String name) { this.name = name; return this; } + /** + * Gets type. + * + * @return the type + */ public String getType() { return type.getFullQualifiedNameAsString(); } + /** + * Gets type fQN. + * + * @return the type fQN + */ public FullQualifiedName getTypeFQN() { return type; } + /** + * Sets type. + * + * @param type the type + * @return the type + */ public CsdlParameter setType(final String type) { this.type = new FullQualifiedName(type); return this; } + /** + * Sets type. + * + * @param type the type + * @return the type + */ public CsdlParameter setType(final FullQualifiedName type) { this.type = type; return this; } + /** + * Is collection. + * + * @return the boolean + */ public boolean isCollection() { return isCollection; } + /** + * Sets collection. + * + * @param isCollection the is collection + * @return the collection + */ public CsdlParameter setCollection(final boolean isCollection) { this.isCollection = isCollection; return this; } + /** + * Is nullable. + * + * @return the boolean + */ public boolean isNullable() { return nullable; } + /** + * Sets nullable. + * + * @param nullable the nullable + * @return the nullable + */ public CsdlParameter setNullable(final boolean nullable) { this.nullable = nullable; return this; } + /** + * Gets max length. + * + * @return the max length + */ public Integer getMaxLength() { return maxLength; } + /** + * Sets max length. + * + * @param maxLength the max length + * @return the max length + */ public CsdlParameter setMaxLength(final Integer maxLength) { this.maxLength = maxLength; return this; } + /** + * Gets precision. + * + * @return the precision + */ public Integer getPrecision() { return precision; } + /** + * Sets precision. + * + * @param precision the precision + * @return the precision + */ public CsdlParameter setPrecision(final Integer precision) { this.precision = precision; return this; } + /** + * Gets scale. + * + * @return the scale + */ public Integer getScale() { return scale; } + /** + * Sets scale. + * + * @param scale the scale + * @return the scale + */ public CsdlParameter setScale(final Integer scale) { this.scale = scale; return this; } + /** + * Gets srid. + * + * @return the srid + */ public SRID getSrid() { return srid; } + /** + * Sets srid. + * + * @param srid the srid + * @return the srid + */ public CsdlParameter setSrid(final SRID srid) { this.srid = srid; return this; @@ -136,10 +233,21 @@ public class CsdlParameter extends CsdlAbstractEdmItem implements CsdlNamed, Csd return annotations; } + /** + * Gets mapping. + * + * @return the mapping + */ public CsdlMapping getMapping() { return mapping; } + /** + * Sets mapping. + * + * @param mapping the mapping + * @return the mapping + */ public CsdlParameter setMapping(final CsdlMapping mapping) { this.mapping = mapping; return this;
