com.highmobility.autoapi.SetCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hmkit-auto-api Show documentation
hmkit-auto-api
There is a newer version: 13.2.1
/*
 * The MIT License
 *
 * Copyright (c) 2014- High-Mobility GmbH (https://high-mobility.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.highmobility.autoapi;

import com.highmobility.autoapi.property.Property;
import com.highmobility.autoapi.value.Brand;
import com.highmobility.value.Bytes;

import java.util.ArrayList;
import java.util.Calendar;

public class SetCommand extends Command {
    ArrayList propertiesBuilder;

    SetCommand(Integer identifier) {
        this.identifier = identifier;
        type = Type.SET;
        // bytes are created later with createBytes()
    }

    /**
     * Add a property to the command. It is used in SetCommands, to create the bytes and properties
     * array.
     *
     * @param property The property.
     */
    protected void addProperty(Property property) {
        if (property == null || property.getValueComponent() == null) return;
        if (propertiesBuilder == null) propertiesBuilder = new ArrayList<>();
        propertiesBuilder.add(property);
    }

    protected void createBytes() {
        if (propertiesBuilder == null) propertiesBuilder = new ArrayList<>();
        findUniversalProperties(identifier, type, propertiesBuilder.toArray(new Property[0]),
                true);
    }

    SetCommand(byte[] bytes) throws CommandParseException {
        super(bytes);
        if (bytes[Command.COMMAND_TYPE_POSITION] != Type.SET) throw new CommandParseException();
    }

    public SetCommand(Builder builder) {
        super(builder.identifier, Type.SET, builder.propertiesBuilder.toArray(new Property[0]));
    }

    public static class Builder {
        private final Integer identifier;

        protected ArrayList propertiesBuilder = new ArrayList<>();

        public Builder(Integer identifier) {
            this.identifier = identifier;
        }

        public Builder addProperty(Property property) {
            propertiesBuilder.add(property);
            return this;
        }

        /**
         * @param nonce The nonce used for the signature.
         * @return The nonce.
         */
        public Builder setNonce(Bytes nonce) {
            addProperty(new Property<>(NONCE_IDENTIFIER, nonce));
            return this;
        }

        /**
         * @param signature The signature for the signed bytes(the whole command except the
         *                  signature property)
         * @return The builder.
         */
        public Builder setSignature(Bytes signature) {
            addProperty(new Property<>(SIGNATURE_IDENTIFIER, signature));
            return this;
        }

        /**
         * @param timestamp The timestamp of when the data was transmitted from the car.
         * @return The builder.
         */
        public Builder setTimestamp(Calendar timestamp) {
            addProperty(new Property<>(TIMESTAMP_IDENTIFIER, timestamp));
            return this;
        }

        /**
         * @param vin The car vin.
         * @return The builder.
         */
        public Builder setVin(String vin) {
            addProperty(new Property<>(VIN_IDENTIFIER, vin));
            return this;
        }

        /**
         * @param brand The car brand.
         * @return The builder.
         */
        public Builder setBrand(Brand brand) {
            addProperty(new Property<>(BRAND_IDENTIFIER, brand));
            return this;
        }

        protected SetCommand build() {
            return new SetCommand(this);
        }

        protected Property[] getProperties() {
            return propertiesBuilder.toArray(new Property[0]);
        }
    }
}