Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 120BE200B74 for ; Thu, 1 Sep 2016 21:56:29 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 10A6E160AB5; Thu, 1 Sep 2016 19:56:29 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 3142B160AA8 for ; Thu, 1 Sep 2016 21:56:28 +0200 (CEST) Received: (qmail 16759 invoked by uid 500); 1 Sep 2016 19:56:27 -0000 Mailing-List: contact dev-help@accumulo.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@accumulo.apache.org Delivered-To: mailing list dev@accumulo.apache.org Received: (qmail 16744 invoked by uid 99); 1 Sep 2016 19:56:26 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 01 Sep 2016 19:56:26 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id CB913E00C4; Thu, 1 Sep 2016 19:56:26 +0000 (UTC) From: madrob To: dev@accumulo.apache.org Reply-To: dev@accumulo.apache.org References: In-Reply-To: Subject: [GitHub] accumulo pull request #145: ACCUMULO-4376 add KeyBuilder Content-Type: text/plain Message-Id: <20160901195626.CB913E00C4@git1-us-west.apache.org> Date: Thu, 1 Sep 2016 19:56:26 +0000 (UTC) archived-at: Thu, 01 Sep 2016 19:56:29 -0000 Github user madrob commented on a diff in the pull request: https://github.com/apache/accumulo/pull/145#discussion_r77242371 --- Diff: core/src/main/java/org/apache/accumulo/core/data/KeyBuilder.java --- @@ -0,0 +1,278 @@ +/* + * 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.accumulo.core.data; + + +import org.apache.hadoop.io.Text; + +/** + * A builder used to build Keys by defining their components. + * + * The rules are: + *

All components of the Key are optional except the row
Components not explicitly set default to empty byte array except the timestamp which + * defaults to Long.MAX_VALUE
The column qualifier can only be set if the column family has been set first
The column visibility can only be set if at least the column family has been set first

+ * + * The builder supports three types of components: byte[], Text and CharSequence. + * + * The builder is mutable and not thread safe. + * + * @see org.apache.accumulo.core.data.Key + * @since 1.8 + */ +public class KeyBuilder { + + public interface Build { + + /** + * Build a Key from this builder. + * + * @param copyBytes + * if the byte arrays should be copied or not. If not, byte arrays will be reused in the resultant Key + * @return + * the Key built from this builder + */ + Key build(boolean copyBytes); + + /** + * Build a Key from this builder. copyBytes defaults to true. + * + * @return + * the Key built from this builder + */ + Key build(); + + /** + * Change the timestamp of the Key created. + * + * @param timestamp + * the timestamp to use for the Key + * @return this builder + */ + Build timestamp(long timestamp); + + /** + * Set the deleted marker of the Key to the parameter. + * + * @param deleted + * if the Key should be marked as deleted or not + * @return this builder + */ + Build deleted(boolean deleted); + } + + public interface ColumnFamilyStep extends ColumnVisibilityStep { + + /** + * Set the column family of the Key that this builder will build to the parameter. + * + * @param columnFamily + * the column family to use for the Key + * @return this builder + */ + ColumnQualifierStep columnFamily(final T columnFamily); + + /** + * Set the column family, qualifier and visibility of the Key that this builder will build to the parameter. + * + * @param columnFamily + * the column family to use for the Key + * @param columnQualifier + * the column qualifier to use for the Key + * @param columnVisibility + * the column visibility to use for the Key + * @return this builder + */ + Build column(final T columnFamily, final T columnQualifier, final T columnVisibility); + + /** + * Set the column family and the qualifier of the Key that this builder will build to the parameter. + * + * @param columnFamily + * the column family to use for the Key + * @param columnQualifier + * the column qualifier to use for the Key + * @return this builder + */ + ColumnVisibilityStep column(final T columnFamily, final T columnQualifier); + } + + public interface ColumnQualifierStep extends ColumnVisibilityStep { + + /** + * Set the column qualifier of the Key that this builder will build to the parameter. + * + * @param columnQualifier + * the column qualifier to use for the Key + * @return this builder + */ + ColumnVisibilityStep columnQualifier(final T columnQualifier); + } + + public interface ColumnVisibilityStep extends Build { + /** + * Set the column qualifier of the Key that this builder will build to the parameter. + * + * @param columnVisibility + * the column visibility to use for the Key + * @return this builder + */ + Build columnVisibility(final T columnVisibility); + } + + private static abstract class AbstractKeyBuilder implements ColumnFamilyStep, ColumnQualifierStep, + ColumnVisibilityStep { + + protected static final byte EMPTY_BYTES[] = new byte[0]; --- End diff -- Declare this `private static final` in KeyBuilder. --- 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 infrastructure@apache.org or file a JIRA ticket with INFRA. ---