[
https://issues.apache.org/jira/browse/BEAM-6240?focusedWorklogId=182071&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-182071
]
ASF GitHub Bot logged work on BEAM-6240:
----------------------------------------
Author: ASF GitHub Bot
Created on: 07/Jan/19 22:50
Start Date: 07/Jan/19 22:50
Worklog Time Spent: 10m
Work Description: reuvenlax commented on pull request #7289: [BEAM-6240]
Add a library of schema annotations for POJO and JavaBeans
URL: https://github.com/apache/beam/pull/7289#discussion_r245825617
##########
File path:
sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/annotations/FieldName.java
##########
@@ -0,0 +1,54 @@
+/*
+ * 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.
+ */
+package org.apache.beam.sdk.schemas.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import javax.annotation.CheckForNull;
+import org.apache.beam.sdk.annotations.Experimental;
+import org.apache.beam.sdk.annotations.Experimental.Kind;
+
+/**
+ * When used on a POJO field or a JavaBean getter, the specified name is used
for the generated
+ * schema field.
+ *
+ * <p>For example, a Java POJO with a field that we want in our schema but
under a different name.
+ *
+ * <pre><code>
+ * {@literal @}DefaultSchema(JavaBeanSchema.class)
+ * class MyClass {
+ * public String user;
+ * {@literal @}SchemaName("age")
+ * public int ageInYears;
+ * }
+ * </code></pre>
+ *
+ * <p>The resulting schema will have fields named "user" and "age."
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.FIELD, ElementType.METHOD})
+@SuppressWarnings("rawtypes")
+@Experimental(Kind.SCHEMAS)
+public @interface FieldName {
+ @CheckForNull
Review comment:
Good point. Our build assumes everything is @Nonnull unless explicitly
marked @Nullable, so I'll just delete the annotation.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 182071)
Time Spent: 4h 10m (was: 4h)
> Allow users to annotate POJOs and JavaBeans for richer functionality
> --------------------------------------------------------------------
>
> Key: BEAM-6240
> URL: https://issues.apache.org/jira/browse/BEAM-6240
> Project: Beam
> Issue Type: Sub-task
> Components: sdk-java-core
> Reporter: Reuven Lax
> Assignee: Reuven Lax
> Priority: Major
> Time Spent: 4h 10m
> Remaining Estimate: 0h
>
> Desired annotations:
> * SchemaIgnore - ignore this field
> * FieldName - allow the user to explicitly specify a field name
> * SchemaCreate - register a function to be used to create an object (so
> fields can be final, and no default constructor need be assumed).
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
