gnu.io.rfc2217.NotifyLineStateCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nrjavaserial-rfc2217 Show documentation

"nrjavaserial-rfc2217" is a Java library which adds RFC2217 support to the "nrjavaserial" library (see http://github.com/NeuronRobotics/nrjavaserial). Therefore it incorporates code from the "jvser" library (see http://github.com/archiecobbs/jvser).

The newest version!


/*
 * Copyright (C) 2010 Archie L. Cobbs. All rights reserved.
 *
 * $Id: NotifyLineStateCommand.java 39 2011-03-22 17:21:53Z archie.cobbs $
 */

package gnu.io.rfc2217;

import static gnu.io.rfc2217.RFC2217.COM_PORT_OPTION;
import static gnu.io.rfc2217.RFC2217.NOTIFY_LINESTATE;
import static gnu.io.rfc2217.RFC2217.SERVER_OFFSET;

/**
 * RFC 2217 {@code NOTIFY-LINESTATE} command.
 *
 * @see RFC 2217
 */
public class NotifyLineStateCommand extends ComPortCommand {

    private int lineState;

    /**
     * Decoding constructor.
     *
     * @param bytes encoded option starting with the {@code COM-PORT-OPTION} byte
     * @throws NullPointerException if {@code bytes} is null
     * @throws IllegalArgumentException if {@code bytes} has length != 3
     * @throws IllegalArgumentException if {@code bytes[0]} is not {@link RFC2217#COM_PORT_OPTION}
     * @throws IllegalArgumentException if {@code bytes[1]} is not {@link RFC2217#NOTIFY_LINESTATE} (client or server)
     */
    public NotifyLineStateCommand(int[] bytes) {
        super("NOTIFY-LINESTATE", NOTIFY_LINESTATE, bytes);
        this.lineState = bytes[2];
    }

    /**
     * Encoding constructor.
     *
     * @param lineState line state value
     * @param client true for the client-to-server command, false for the server-to-client command
     */
    public NotifyLineStateCommand(boolean client, int lineState) {
        this(new int[] {
            COM_PORT_OPTION,
            client ? NOTIFY_LINESTATE : NOTIFY_LINESTATE + SERVER_OFFSET,
            lineState
        });
    }

    @Override
    public String toString() {
        return this.getName() + " " + Util.decodeBits(this.lineState, Util.LINE_STATE_BITS);
    }

    @Override
    public void visit(ComPortCommandSwitch sw) {
        sw.caseNotifyLineState(this);
    }

    public int getLineState() {
        return this.lineState;
    }

    @Override
    int getMinPayloadLength() {
        return 1;
    }

    @Override
    int getMaxPayloadLength() {
        return 1;
    }
}