com.splicemachine.pipeline.constraint.ConstraintContext.java Source code

Introduction

Here is the source code for com.splicemachine.pipeline.constraint.ConstraintContext.java

Source

/*
 * Copyright 2012 - 2016 Splice Machine, Inc.
 *
 * Licensed 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 com.splicemachine.pipeline.constraint;

import com.splicemachine.ddl.DDLMessage.*;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.apache.commons.lang3.ArrayUtils;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.Arrays;

/**
 * Immutable class representing a named constraint on a named table.
 */
public class ConstraintContext implements Externalizable {

    /* The message args which will be passed to our StandardException factory method for creating a constraint
     * violation message appropriate for the constraint. */
    private String[] messageArgs;

    // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    // convenient factory methods for various types of constraints
    // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    public static ConstraintContext empty() {
        return new ConstraintContext(null);
    }

    public static ConstraintContext unique(String tableName, String constraintName) {
        return new ConstraintContext(constraintName, tableName);
    }

    public static ConstraintContext primaryKey(String tableName, String constraintName) {
        return new ConstraintContext(constraintName, tableName);
    }

    public static ConstraintContext foreignKey(FKConstraintInfo fkConstraintInfo) {
        String tableName = fkConstraintInfo.getTableName();
        String constraintName = fkConstraintInfo.getConstraintName();
        String columnNames = fkConstraintInfo.getColumnNames();
        return new ConstraintContext(constraintName, tableName, "Operation", "(" + columnNames + ")");
    }

    // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    /* For serialization */
    @Deprecated
    public ConstraintContext() {
    }

    /* Use factory methods above instead for clarity */
    public ConstraintContext(String... messageArgs) {
        this.messageArgs = messageArgs;
    }

    /* Copy but with specified argument inserted at specified index */
    public ConstraintContext withInsertedMessage(int index, String newMessage) {
        return new ConstraintContext((String[]) ArrayUtils.add(messageArgs, index, newMessage));
    }

    /* Copy but with specified argument removed */
    public ConstraintContext withoutMessage(int index) {
        return new ConstraintContext((String[]) ArrayUtils.remove(messageArgs, index));
    }

    /* Copy but with specified argument set at specified index */
    public ConstraintContext withMessage(int index, String newMessage) {
        String[] newArgs = Arrays.copyOf(this.messageArgs, this.messageArgs.length);
        newArgs[index] = newMessage;
        return new ConstraintContext(newArgs);
    }

    @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Intentional")
    public String[] getMessages() {
        return messageArgs;
    }

    @Override
    public boolean equals(Object o) {
        return (this == o) || (o instanceof ConstraintContext)
                && Arrays.equals(this.messageArgs, ((ConstraintContext) o).messageArgs);
    }

    @Override
    public int hashCode() {
        return Arrays.hashCode(messageArgs);
    }

    @Override
    public void readExternal(ObjectInput objectInput) throws IOException, ClassNotFoundException {
        short len = objectInput.readShort();
        if (len > 0) {
            messageArgs = new String[len];
            for (int i = 0; i < messageArgs.length; i++) {
                messageArgs[i] = objectInput.readUTF();
            }
        }
    }

    @Override
    public void writeExternal(ObjectOutput objectOutput) throws IOException {
        short len = (short) (messageArgs == null ? 0 : messageArgs.length);
        objectOutput.writeShort(len);
        for (int i = 0; i < len; i++) {
            objectOutput.writeUTF(messageArgs[i]);
        }
    }

    @Override
    public String toString() {
        return "ConstraintContext{" + "messageArgs=" + Arrays.toString(messageArgs) + '}';
    }
}