From 081a38001f46082d5b97c80e2faa87bfc50ca420 Mon Sep 17 00:00:00 2001 From: Michael Bolz Date: Fri, 11 Sep 2015 09:02:16 +0200 Subject: [PATCH] [OLINGO-659] Fixed javadoc issues --- .../olingo/osgi/itests/BundlesTest.java | 2 +- .../osgi/itests/OlingoOSGiTestSupport.java | 2 +- .../osgi/itests/server/CarServiceTest.java | 2 +- .../olingo/fit/server/TomcatTestServer.java | 2 +- .../apache/olingo/fit/util/StringHelper.java | 2 +- .../api/edm/annotation/package-info.java | 24 +++++++++++++++++ .../api/edm/constants/package-info.java | 24 +++++++++++++++++ .../commons/api/edm/geo/package-info.java | 24 +++++++++++++++++ .../edm/provider/annotation/package-info.java | 23 ++++++++++++++++ .../olingo/commons/api/ex/package-info.java | 22 +++++++++++++++ .../olingo/commons/api/format/AcceptType.java | 4 +-- .../commons/api/http/HttpContentType.java | 4 +-- .../olingo/commons/api/http/HttpHeader.java | 4 +-- .../olingo/commons/api/http/HttpHeaders.java | 4 +-- .../commons/api/http/HttpStatusCode.java | 4 +-- .../olingo/commons/api/package-info.java | 23 ++++++++++++++++ .../apache/olingo/commons/core/Decoder.java | 4 +-- .../apache/olingo/commons/core/Encoder.java | 4 +-- .../olingo/commons/core/DecoderTest.java | 4 +-- .../olingo/commons/core/EncoderTest.java | 4 +-- .../olingo/server/api/batch/package-info.java | 26 ++++++++++++++++++ .../olingo/server/api/debug/package-info.java | 26 ++++++++++++++++++ .../api/deserializer/batch/package-info.java | 26 ++++++++++++++++++ .../server/api/deserializer/package-info.java | 26 ++++++++++++++++++ .../olingo/server/api/edmx/package-info.java | 26 ++++++++++++++++++ .../olingo/server/api/etag/package-info.java | 26 ++++++++++++++++++ .../olingo/server/api/package-info.java | 4 +-- .../server/api/prefer/package-info.java | 26 ++++++++++++++++++ .../server/api/processor/package-info.java | 4 +-- .../server/api/serializer/package-info.java | 26 ++++++++++++++++++ .../olingo/server/api/uri/package-info.java | 4 +-- .../api/uri/queryoption/AliasQueryOption.java | 7 +++-- .../api/uri/queryoption/FilterOption.java | 4 +-- .../api/uri/queryoption/SearchOption.java | 4 +-- .../queryoption/expression/MethodKind.java | 4 +-- .../queryoption/expression/package-info.java | 27 +++++++++++++++++++ .../api/uri/queryoption/package-info.java | 26 ++++++++++++++++++ .../uri/queryoption/search/package-info.java | 27 +++++++++++++++++++ .../uri/parser/CheckFullContextListener.java | 4 +-- .../utils/CircleStreamBufferTest.java | 4 +-- .../samples/client/OlingoSampleApp.java | 2 +- 41 files changed, 471 insertions(+), 44 deletions(-) create mode 100644 lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/annotation/package-info.java create mode 100644 lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/package-info.java create mode 100644 lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/geo/package-info.java create mode 100644 lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/annotation/package-info.java create mode 100644 lib/commons-api/src/main/java/org/apache/olingo/commons/api/ex/package-info.java create mode 100644 lib/commons-api/src/main/java/org/apache/olingo/commons/api/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/batch/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/debug/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/deserializer/batch/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/deserializer/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/edmx/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/etag/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/prefer/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/expression/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/package-info.java create mode 100644 lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/search/package-info.java diff --git a/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/BundlesTest.java b/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/BundlesTest.java index 85d0f4220..7b89bf603 100644 --- a/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/BundlesTest.java +++ b/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/BundlesTest.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information diff --git a/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/OlingoOSGiTestSupport.java b/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/OlingoOSGiTestSupport.java index b95bd134b..454fd2e52 100644 --- a/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/OlingoOSGiTestSupport.java +++ b/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/OlingoOSGiTestSupport.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information diff --git a/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/server/CarServiceTest.java b/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/server/CarServiceTest.java index d727253d3..ce24f0bd5 100644 --- a/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/server/CarServiceTest.java +++ b/ext/karaf/karaf-fit/src/test/java/org/apache/olingo/osgi/itests/server/CarServiceTest.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information diff --git a/fit/src/main/java/org/apache/olingo/fit/server/TomcatTestServer.java b/fit/src/main/java/org/apache/olingo/fit/server/TomcatTestServer.java index 69d03145c..eb79dd845 100644 --- a/fit/src/main/java/org/apache/olingo/fit/server/TomcatTestServer.java +++ b/fit/src/main/java/org/apache/olingo/fit/server/TomcatTestServer.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information diff --git a/fit/src/test/java/org/apache/olingo/fit/util/StringHelper.java b/fit/src/test/java/org/apache/olingo/fit/util/StringHelper.java index 8b2e9a1b7..9f3edf31c 100644 --- a/fit/src/test/java/org/apache/olingo/fit/util/StringHelper.java +++ b/fit/src/test/java/org/apache/olingo/fit/util/StringHelper.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/annotation/package-info.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/annotation/package-info.java new file mode 100644 index 000000000..41c51849a --- /dev/null +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/annotation/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Contains representations for all annotation related + * EDM objects created during the URI parsing + */ +package org.apache.olingo.commons.api.edm.annotation; + diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/package-info.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/package-info.java new file mode 100644 index 000000000..4bcdf3626 --- /dev/null +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Contains representations for all constants related + * EDM objects created during the URI parsing + */ +package org.apache.olingo.commons.api.edm.constants; + diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/geo/package-info.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/geo/package-info.java new file mode 100644 index 000000000..349c2769b --- /dev/null +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/geo/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Contains representations for all geographical related + * EDM objects created during the URI parsing + */ +package org.apache.olingo.commons.api.edm.geo; + diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/annotation/package-info.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/annotation/package-info.java new file mode 100644 index 000000000..0bb108dcc --- /dev/null +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/provider/annotation/package-info.java @@ -0,0 +1,23 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Contains representations for objects created during + * CSDL document parsing related to the CSDL annotations. + */ +package org.apache.olingo.commons.api.edm.provider.annotation; \ No newline at end of file diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/ex/package-info.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/ex/package-info.java new file mode 100644 index 000000000..04300d2b3 --- /dev/null +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/ex/package-info.java @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Contains all OData errors and exceptions related classes. + */ +package org.apache.olingo.commons.api.ex; \ No newline at end of file diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/format/AcceptType.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/format/AcceptType.java index bd573af64..c1e50a782 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/format/AcceptType.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/format/AcceptType.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.commons.api.format; import java.util.ArrayList; diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpContentType.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpContentType.java index 12301f829..31d252b60 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpContentType.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpContentType.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.commons.api.http; /** diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpHeader.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpHeader.java index 340c89525..323655b03 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpHeader.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpHeader.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.commons.api.http; import java.util.ArrayList; diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpHeaders.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpHeaders.java index fb1da7f9c..272167038 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpHeaders.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpHeaders.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.commons.api.http; import java.util.ArrayList; diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpStatusCode.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpStatusCode.java index f33942926..e5ff04c0e 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpStatusCode.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/http/HttpStatusCode.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.commons.api.http; /** diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/package-info.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/package-info.java new file mode 100644 index 000000000..416a56fe5 --- /dev/null +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/package-info.java @@ -0,0 +1,23 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Contains all OData commons classes which are not more specific + * (e.g. Constants which can be used in every context). + */ +package org.apache.olingo.commons.api; \ No newline at end of file diff --git a/lib/commons-core/src/main/java/org/apache/olingo/commons/core/Decoder.java b/lib/commons-core/src/main/java/org/apache/olingo/commons/core/Decoder.java index f8e885e25..dafbb8c5b 100644 --- a/lib/commons-core/src/main/java/org/apache/olingo/commons/core/Decoder.java +++ b/lib/commons-core/src/main/java/org/apache/olingo/commons/core/Decoder.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.commons.core; import java.io.UnsupportedEncodingException; diff --git a/lib/commons-core/src/main/java/org/apache/olingo/commons/core/Encoder.java b/lib/commons-core/src/main/java/org/apache/olingo/commons/core/Encoder.java index edbf9ef12..50ee28faf 100644 --- a/lib/commons-core/src/main/java/org/apache/olingo/commons/core/Encoder.java +++ b/lib/commons-core/src/main/java/org/apache/olingo/commons/core/Encoder.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.commons.core; import java.io.UnsupportedEncodingException; diff --git a/lib/commons-core/src/test/java/org/apache/olingo/commons/core/DecoderTest.java b/lib/commons-core/src/test/java/org/apache/olingo/commons/core/DecoderTest.java index 09f232697..081cc387c 100644 --- a/lib/commons-core/src/test/java/org/apache/olingo/commons/core/DecoderTest.java +++ b/lib/commons-core/src/test/java/org/apache/olingo/commons/core/DecoderTest.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.commons.core; import static org.junit.Assert.assertEquals; diff --git a/lib/commons-core/src/test/java/org/apache/olingo/commons/core/EncoderTest.java b/lib/commons-core/src/test/java/org/apache/olingo/commons/core/EncoderTest.java index 7db30cea4..18afe6f9e 100644 --- a/lib/commons-core/src/test/java/org/apache/olingo/commons/core/EncoderTest.java +++ b/lib/commons-core/src/test/java/org/apache/olingo/commons/core/EncoderTest.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.commons.core; import static org.junit.Assert.assertEquals; diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/batch/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/batch/package-info.java new file mode 100644 index 000000000..a6952ad2b --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/batch/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - Batch + *

+ * The batch package is used to condense common parts about the OData batch processing. + * + */ +package org.apache.olingo.server.api.batch; + diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/debug/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/debug/package-info.java new file mode 100644 index 000000000..91c95e65b --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/debug/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - Debug + *

+ * The debug package is used to condense all information about the Olingo debug handling. + * + */ +package org.apache.olingo.server.api.debug; + diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/deserializer/batch/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/deserializer/batch/package-info.java new file mode 100644 index 000000000..41554cb90 --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/deserializer/batch/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - Deserializer - Batch + *

+ * The deserializer.batch package is used to condense all about the Olingo batch deserialization. + * + */ +package org.apache.olingo.server.api.deserializer.batch; + diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/deserializer/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/deserializer/package-info.java new file mode 100644 index 000000000..499d68429 --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/deserializer/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - Deserializer + *

+ * The deserializer package is used to condense all about the Olingo deserialization. + * + */ +package org.apache.olingo.server.api.deserializer; + diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/edmx/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/edmx/package-info.java new file mode 100644 index 000000000..243d8940a --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/edmx/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - Edmx + *

+ * The edmx package is used to condense all about the Olingo OData EDMX handling. + * + */ +package org.apache.olingo.server.api.edmx; + diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/etag/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/etag/package-info.java new file mode 100644 index 000000000..82ebdc884 --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/etag/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - ETag + *

+ * The etag package is used to condense all about the Olingo ETag handling. + * + */ +package org.apache.olingo.server.api.etag; + diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/package-info.java index 2cdb677ac..d87d42ea4 100644 --- a/lib/server-api/src/main/java/org/apache/olingo/server/api/package-info.java +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/package-info.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ /** * Olingo Server API *

diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/prefer/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/prefer/package-info.java new file mode 100644 index 000000000..7d387d578 --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/prefer/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - Prefer + *

+ * The prefer package is used to condense all about the Olingo Prefer handling. + * + */ +package org.apache.olingo.server.api.prefer; + diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/processor/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/processor/package-info.java index bc21fd090..c1a1b0f45 100644 --- a/lib/server-api/src/main/java/org/apache/olingo/server/api/processor/package-info.java +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/processor/package-info.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ /** * Olingo Processors *

diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/package-info.java new file mode 100644 index 000000000..7733e2c1c --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - Serializer + *

+ * The serializer package is used to condense all about the Olingo serialization. + * + */ +package org.apache.olingo.server.api.serializer; + diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/package-info.java index 2a0aab689..091f83305 100644 --- a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/package-info.java +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/package-info.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ /** * Olingo URI *

diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/AliasQueryOption.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/AliasQueryOption.java index dffb0be35..4f36803aa 100644 --- a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/AliasQueryOption.java +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/AliasQueryOption.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.server.api.uri.queryoption; import org.apache.olingo.server.api.uri.queryoption.expression.Expression; @@ -30,6 +30,5 @@ public interface AliasQueryOption extends QueryOption { /** * @return Value of the alias */ - public Expression getValue(); - + Expression getValue(); } diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/FilterOption.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/FilterOption.java index a45208fee..87c118340 100644 --- a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/FilterOption.java +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/FilterOption.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.server.api.uri.queryoption; import org.apache.olingo.server.api.uri.queryoption.expression.Expression; diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/SearchOption.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/SearchOption.java index 628f6385a..762ff038a 100644 --- a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/SearchOption.java +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/SearchOption.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.server.api.uri.queryoption; import org.apache.olingo.server.api.uri.queryoption.search.SearchExpression; diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/expression/MethodKind.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/expression/MethodKind.java index 93e5e4b1d..842cfad62 100644 --- a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/expression/MethodKind.java +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/expression/MethodKind.java @@ -58,9 +58,9 @@ public enum MethodKind { /** * Constructor for enumeration value - * @param Syntax used in the URI + * @param syntax used in the URI */ - private MethodKind(final String syntax) { + MethodKind(final String syntax) { this.syntax = syntax; } diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/expression/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/expression/package-info.java new file mode 100644 index 000000000..4de05fcb9 --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/expression/package-info.java @@ -0,0 +1,27 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - URI - QueryOptions - Expressions + *

+ * The uri.queryoption.expression package is used to condense all about + * the Olingo expressions within the query options (in uri context). + * + */ +package org.apache.olingo.server.api.uri.queryoption.expression; + diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/package-info.java new file mode 100644 index 000000000..977226c00 --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/package-info.java @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - URI - QueryOptions + *

+ * The uri.queryoption package is used to condense all about the Olingo query options (in uri context). + * + */ +package org.apache.olingo.server.api.uri.queryoption; + diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/search/package-info.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/search/package-info.java new file mode 100644 index 000000000..7d98835ad --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/uri/queryoption/search/package-info.java @@ -0,0 +1,27 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +/** + * Olingo Server API - URI - QueryOptions - Search + *

+ * The uri.queryoption.search package is used to condense all about + * the Olingo search options within the query options (in uri context). + * + */ +package org.apache.olingo.server.api.uri.queryoption.search; + diff --git a/lib/server-core/src/main/java/org/apache/olingo/server/core/uri/parser/CheckFullContextListener.java b/lib/server-core/src/main/java/org/apache/olingo/server/core/uri/parser/CheckFullContextListener.java index cfa54624f..86efdca86 100644 --- a/lib/server-core/src/main/java/org/apache/olingo/server/core/uri/parser/CheckFullContextListener.java +++ b/lib/server-core/src/main/java/org/apache/olingo/server/core/uri/parser/CheckFullContextListener.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.server.core.uri.parser; import java.util.BitSet; diff --git a/lib/server-core/src/test/java/org/apache/olingo/server/core/serializer/utils/CircleStreamBufferTest.java b/lib/server-core/src/test/java/org/apache/olingo/server/core/serializer/utils/CircleStreamBufferTest.java index 9ac2c81d9..b5c28bc93 100644 --- a/lib/server-core/src/test/java/org/apache/olingo/server/core/serializer/utils/CircleStreamBufferTest.java +++ b/lib/server-core/src/test/java/org/apache/olingo/server/core/serializer/utils/CircleStreamBufferTest.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -15,7 +15,7 @@ * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. - ******************************************************************************/ + */ package org.apache.olingo.server.core.serializer.utils; import static org.junit.Assert.assertEquals; diff --git a/samples/client/src/main/java/org/apache/olingo/samples/client/OlingoSampleApp.java b/samples/client/src/main/java/org/apache/olingo/samples/client/OlingoSampleApp.java index 9b627a6df..5382116de 100644 --- a/samples/client/src/main/java/org/apache/olingo/samples/client/OlingoSampleApp.java +++ b/samples/client/src/main/java/org/apache/olingo/samples/client/OlingoSampleApp.java @@ -1,4 +1,4 @@ -/******************************************************************************* +/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information