Github user mattf-horton commented on a diff in the pull request:

    https://github.com/apache/metron/pull/530#discussion_r131797034
  
    --- Diff: 
bundles-lib/src/main/java/org/apache/metron/bundles/bundle/BundleDetails.java 
---
    @@ -0,0 +1,189 @@
    +/*
    + * 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.metron.bundles.bundle;
    +
    +import org.apache.commons.vfs2.FileObject;
    +
    +import java.text.ParseException;
    +import java.text.SimpleDateFormat;
    +import java.util.Date;
    +
    +/**
    + * Metadata about a bundle.
    + */
    +public class BundleDetails {
    +
    +    private final FileObject bundleFile;
    +
    +    private final BundleCoordinate coordinate;
    +    private final BundleCoordinate dependencyCoordinate;
    +
    +    private final String buildTag;
    +    private final String buildRevision;
    +    private final String buildBranch;
    +    private final String buildTimestamp;
    +    private final String buildJdk;
    +    private final String builtBy;
    +
    +    private BundleDetails(final Builder builder) {
    +        this.bundleFile = builder.bundleFile;
    +        this.coordinate = builder.coordinate;
    +        this.dependencyCoordinate = builder.dependencyCoordinate;
    +
    +        this.buildTag = builder.buildTag;
    +        this.buildRevision = builder.buildRevision;
    +        this.buildBranch = builder.buildBranch;
    +        this.buildTimestamp = builder.buildTimestamp;
    +        this.buildJdk = builder.buildJdk;
    +        this.builtBy = builder.builtBy;
    +
    +        if (this.coordinate == null) {
    +            if (this.bundleFile == null) {
    +                throw new IllegalStateException("Coordinate cannot be 
null");
    +            } else {
    +                throw new IllegalStateException("Coordinate cannot be null 
for " + this.bundleFile.getName());
    +            }
    +        }
    +
    +        if (this.bundleFile == null) {
    +            throw new IllegalStateException("Working directory cannot be 
null for " + this.coordinate.getId());
    +        }
    +    }
    +
    +    public FileObject getBundleFile() {
    +        return bundleFile;
    +    }
    +
    +    public BundleCoordinate getCoordinate() {
    +        return coordinate;
    +    }
    +
    +    public BundleCoordinate getDependencyCoordinate() {
    +        return dependencyCoordinate;
    +    }
    +
    +    public String getBuildTag() {
    +        return buildTag;
    +    }
    +
    +    public String getBuildRevision() {
    +        return buildRevision;
    +    }
    +
    +    public String getBuildBranch() {
    +        return buildBranch;
    +    }
    +
    +    public String getBuildTimestamp() {
    +        return buildTimestamp;
    +    }
    +
    +    public String getBuildJdk() {
    +        return buildJdk;
    +    }
    +
    +    public String getBuiltBy() {
    +        return builtBy;
    +    }
    +
    +    @Override
    +    public String toString() {
    +        return coordinate.toString();
    +    }
    +
    +    public Date getBuildTimestampDate() {
    +        if (buildTimestamp != null && !buildTimestamp.isEmpty()) {
    +            try {
    +                SimpleDateFormat buildTimestampFormat = new 
SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
    +                Date buildTimestampDate = 
buildTimestampFormat.parse(buildTimestamp);
    +                return buildTimestampDate;
    +            } catch (ParseException parseEx) {
    +                return null;
    +            }
    +        } else {
    +            return null;
    +        }
    +    }
    +
    +    /**
    +     * Builder for BundleDetails.
    +     */
    +    public static class Builder {
    +
    +        private FileObject bundleFile;
    +
    +        private BundleCoordinate coordinate;
    +        private BundleCoordinate dependencyCoordinate;
    +
    +        private String buildTag;
    +        private String buildRevision;
    +        private String buildBranch;
    +        private String buildTimestamp;
    +        private String buildJdk;
    +        private String builtBy;
    +
    +        public Builder bundleFile(final FileObject bundleFile) {
    --- End diff --
    
    It would be typical, though not required, to prefix the fluent build 
methods with "with".
    For the mandatory fields, it would also make sense to validate them, as 
noted above.  This would be better than doing it at build time, because it 
would happen immediately upon calling the method with the bad value.
    Understood that if the method isn't called it can't test, which is why null 
test is indeed necessary either in "build" method or above.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

Reply via email to