org.neo4j.jdbc.values.BytesValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-jdbc Show documentation

Implementation of the Neo4j JDBC driver.

There is a newer version: 6.0.1

/*
 * Copyright (c) 2023-2024 "Neo4j,"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * 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
 *
 *     https://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.neo4j.jdbc.values;

import java.util.Arrays;
import java.util.HexFormat;

/**
 * Representing a byte-array. Note that in Cypher byte arrays cannot be directly used.
 * They are however natively storable in Neo4j.
 *
 * @author Neo4j Drivers Team
 * @since 6.0.0
 */
public final class BytesValue extends AbstractValue {

	private final byte[] val;

	private static final HexFormat FORMATTER = HexFormat.of().withUpperCase();

	BytesValue(byte[] val) {
		if (val == null) {
			throw new IllegalArgumentException("Cannot construct BytesValue from null");
		}
		this.val = val;
	}

	@Override
	public boolean isEmpty() {
		return this.val.length == 0;
	}

	@Override
	public int size() {
		return this.val.length;
	}

	@Override
	public byte[] asObject() {
		return this.val;
	}

	@Override
	public byte[] asByteArray() {
		return this.val;
	}

	@Override
	public Type type() {
		return Type.BYTES;
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}
		if (o == null || getClass() != o.getClass()) {
			return false;
		}

		var values = (BytesValue) o;
		return Arrays.equals(this.val, values.val);
	}

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

	@Override
	public String toString() {
		return "X'" + FORMATTER.formatHex(this.val) + "'";
	}

}