com.highmobility.autoapi.ParkingTicket Maven / Gradle / Ivy
/*
* 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.ByteEnum;
import com.highmobility.autoapi.property.Property;
import com.highmobility.value.Bytes;
import java.util.Calendar;
import javax.annotation.Nullable;
import static com.highmobility.utils.ByteUtils.hexFromByte;
/**
* The Parking Ticket capability
*/
public class ParkingTicket {
public static final int IDENTIFIER = Identifier.PARKING_TICKET;
public static final byte PROPERTY_STATUS = 0x01;
public static final byte PROPERTY_OPERATOR_NAME = 0x02;
public static final byte PROPERTY_OPERATOR_TICKET_ID = 0x03;
public static final byte PROPERTY_TICKET_START_TIME = 0x04;
public static final byte PROPERTY_TICKET_END_TIME = 0x05;
/**
* Get Parking Ticket property availability information.
*/
public static class GetParkingTicketAvailability extends GetAvailabilityCommand {
/**
* Get every Parking Ticket property availability
*/
public GetParkingTicketAvailability() {
super(IDENTIFIER);
}
/**
* Get specific Parking Ticket property availabilities
*
* @param propertyIdentifiers The property identifierBytes
*/
public GetParkingTicketAvailability(Bytes propertyIdentifiers) {
super(IDENTIFIER, propertyIdentifiers);
}
/**
* Get specific Parking Ticket property availabilities
*
* @param propertyIdentifiers The property identifierBytes
*/
public GetParkingTicketAvailability(byte... propertyIdentifiers) {
super(IDENTIFIER, new Bytes(propertyIdentifiers));
}
GetParkingTicketAvailability(byte[] bytes, @SuppressWarnings("unused") boolean fromRaw) throws CommandParseException {
super(bytes);
}
}
/**
* Get parking ticket
*/
public static class GetParkingTicket extends GetCommand {
/**
* Get all Parking Ticket properties
*/
public GetParkingTicket() {
super(State.class, IDENTIFIER);
}
/**
* Get specific Parking Ticket properties
*
* @param propertyIdentifiers The property identifiers
*/
public GetParkingTicket(Bytes propertyIdentifiers) {
super(State.class, IDENTIFIER, propertyIdentifiers);
}
/**
* Get specific Parking Ticket properties
*
* @param propertyIdentifiers The property identifiers
*/
public GetParkingTicket(byte... propertyIdentifiers) {
super(State.class, IDENTIFIER, new Bytes(propertyIdentifiers));
}
GetParkingTicket(byte[] bytes, @SuppressWarnings("unused") boolean fromRaw) throws CommandParseException {
super(State.class, bytes);
}
}
/**
* Get specific Parking Ticket properties
*
* @deprecated use {@link GetParkingTicket#GetParkingTicket(byte...)} instead
*/
@Deprecated
public static class GetParkingTicketProperties extends GetCommand {
/**
* @param propertyIdentifiers The property identifiers
*/
public GetParkingTicketProperties(Bytes propertyIdentifiers) {
super(State.class, IDENTIFIER, propertyIdentifiers);
}
/**
* @param propertyIdentifiers The property identifiers
*/
public GetParkingTicketProperties(byte... propertyIdentifiers) {
super(State.class, IDENTIFIER, new Bytes(propertyIdentifiers));
}
GetParkingTicketProperties(byte[] bytes, @SuppressWarnings("unused") boolean fromRaw) throws CommandParseException {
super(State.class, bytes);
}
}
/**
* Start parking
*/
public static class StartParking extends SetCommand {
Property status = new Property<>(Status.class, PROPERTY_STATUS);
Property operatorName = new Property<>(String.class, PROPERTY_OPERATOR_NAME);
Property operatorTicketID = new Property<>(String.class, PROPERTY_OPERATOR_TICKET_ID);
Property ticketStartTime = new Property<>(Calendar.class, PROPERTY_TICKET_START_TIME);
Property ticketEndTime = new Property<>(Calendar.class, PROPERTY_TICKET_END_TIME);
/**
* @return The operator name
*/
public Property getOperatorName() {
return operatorName;
}
/**
* @return The operator ticket id
*/
public Property getOperatorTicketID() {
return operatorTicketID;
}
/**
* @return The ticket start time
*/
public Property getTicketStartTime() {
return ticketStartTime;
}
/**
* @return The ticket end time
*/
public Property getTicketEndTime() {
return ticketEndTime;
}
/**
* Start parking
*
* @param operatorName Operator name
* @param operatorTicketID Operator ticket ID
* @param ticketStartTime Parking ticket start time
* @param ticketEndTime Parking ticket end time
*/
public StartParking(@Nullable String operatorName, String operatorTicketID, Calendar ticketStartTime, @Nullable Calendar ticketEndTime) {
super(IDENTIFIER);
addProperty(status.addValueComponent(new Bytes("01")));
addProperty(this.operatorName.update(operatorName));
addProperty(this.operatorTicketID.update(operatorTicketID));
addProperty(this.ticketStartTime.update(ticketStartTime));
addProperty(this.ticketEndTime.update(ticketEndTime));
createBytes();
}
StartParking(byte[] bytes) throws CommandParseException, NoPropertiesException {
super(bytes);
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
switch (p.getPropertyIdentifier()) {
case PROPERTY_STATUS: status.update(p);
case PROPERTY_OPERATOR_NAME: return operatorName.update(p);
case PROPERTY_OPERATOR_TICKET_ID: return operatorTicketID.update(p);
case PROPERTY_TICKET_START_TIME: return ticketStartTime.update(p);
case PROPERTY_TICKET_END_TIME: return ticketEndTime.update(p);
}
return null;
});
}
if ((status.getValue() == null || status.getValueComponent().getValueBytes().equals("01") == false) ||
this.operatorTicketID.getValue() == null ||
this.ticketStartTime.getValue() == null)
throw new NoPropertiesException();
}
}
/**
* End parking
*/
public static class EndParking extends SetCommand {
Property status = new Property<>(Status.class, PROPERTY_STATUS);
/**
* End parking
*/
public EndParking() {
super(IDENTIFIER);
addProperty(status.addValueComponent(new Bytes("00")));
createBytes();
}
EndParking(byte[] bytes) throws CommandParseException, NoPropertiesException {
super(bytes);
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
if (p.getPropertyIdentifier() == PROPERTY_STATUS) return status.update(p);
return null;
});
}
if ((status.getValue() == null || status.getValueComponent().getValueBytes().equals("00") == false))
throw new NoPropertiesException();
}
}
/**
* The parking ticket state
*/
public static class State extends SetCommand {
Property status = new Property<>(Status.class, PROPERTY_STATUS);
Property operatorName = new Property<>(String.class, PROPERTY_OPERATOR_NAME);
Property operatorTicketID = new Property<>(String.class, PROPERTY_OPERATOR_TICKET_ID);
Property ticketStartTime = new Property<>(Calendar.class, PROPERTY_TICKET_START_TIME);
Property ticketEndTime = new Property<>(Calendar.class, PROPERTY_TICKET_END_TIME);
/**
* @return The status
*/
public Property getStatus() {
return status;
}
/**
* @return Operator name
*/
public Property getOperatorName() {
return operatorName;
}
/**
* @return Operator ticket ID
*/
public Property getOperatorTicketID() {
return operatorTicketID;
}
/**
* @return Parking ticket start time
*/
public Property getTicketStartTime() {
return ticketStartTime;
}
/**
* @return Parking ticket end time
*/
public Property getTicketEndTime() {
return ticketEndTime;
}
State(byte[] bytes) throws CommandParseException {
super(bytes);
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
switch (p.getPropertyIdentifier()) {
case PROPERTY_STATUS: return status.update(p);
case PROPERTY_OPERATOR_NAME: return operatorName.update(p);
case PROPERTY_OPERATOR_TICKET_ID: return operatorTicketID.update(p);
case PROPERTY_TICKET_START_TIME: return ticketStartTime.update(p);
case PROPERTY_TICKET_END_TIME: return ticketEndTime.update(p);
}
return null;
});
}
}
private State(Builder builder) {
super(builder);
status = builder.status;
operatorName = builder.operatorName;
operatorTicketID = builder.operatorTicketID;
ticketStartTime = builder.ticketStartTime;
ticketEndTime = builder.ticketEndTime;
}
public static final class Builder extends SetCommand.Builder {
private Property status;
private Property operatorName;
private Property operatorTicketID;
private Property ticketStartTime;
private Property ticketEndTime;
public Builder() {
super(IDENTIFIER);
}
public State build() {
return new State(this);
}
/**
* @param status The status
* @return The builder
*/
public Builder setStatus(Property status) {
this.status = status.setIdentifier(PROPERTY_STATUS);
addProperty(this.status);
return this;
}
/**
* @param operatorName Operator name
* @return The builder
*/
public Builder setOperatorName(Property operatorName) {
this.operatorName = operatorName.setIdentifier(PROPERTY_OPERATOR_NAME);
addProperty(this.operatorName);
return this;
}
/**
* @param operatorTicketID Operator ticket ID
* @return The builder
*/
public Builder setOperatorTicketID(Property operatorTicketID) {
this.operatorTicketID = operatorTicketID.setIdentifier(PROPERTY_OPERATOR_TICKET_ID);
addProperty(this.operatorTicketID);
return this;
}
/**
* @param ticketStartTime Parking ticket start time
* @return The builder
*/
public Builder setTicketStartTime(Property ticketStartTime) {
this.ticketStartTime = ticketStartTime.setIdentifier(PROPERTY_TICKET_START_TIME);
addProperty(this.ticketStartTime);
return this;
}
/**
* @param ticketEndTime Parking ticket end time
* @return The builder
*/
public Builder setTicketEndTime(Property ticketEndTime) {
this.ticketEndTime = ticketEndTime.setIdentifier(PROPERTY_TICKET_END_TIME);
addProperty(this.ticketEndTime);
return this;
}
}
}
public enum Status implements ByteEnum {
ENDED((byte) 0x00),
STARTED((byte) 0x01);
public static Status fromByte(byte byteValue) throws CommandParseException {
Status[] values = Status.values();
for (int i = 0; i < values.length; i++) {
Status state = values[i];
if (state.getByte() == byteValue) {
return state;
}
}
throw new CommandParseException("ParkingTicket.Status does not contain: " + hexFromByte(byteValue));
}
private final byte value;
Status(byte value) {
this.value = value;
}
@Override public byte getByte() {
return value;
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy