// Copyright (c) 2009 The Chromium Authors. All rights reserved.

// Use of this source code is governed by a BSD-style license that can be

// found in the LICENSE file.

package org.chromium.sdk.internal.protocol;

import java.util.EnumSet;

import java.util.List;

import org.chromium.sdk.internal.protocol.data.SomeHandle;

import org.chromium.sdk.internal.protocolparser.EnumValueCondition;

import org.chromium.sdk.internal.protocolparser.JsonObjectBased;

import org.chromium.sdk.internal.protocolparser.JsonOptionalField;

import org.chromium.sdk.internal.protocolparser.JsonOverrideField;

import org.chromium.sdk.internal.protocolparser.JsonSubtype;

import org.chromium.sdk.internal.protocolparser.JsonSubtypeConditionCustom;

import org.chromium.sdk.internal.protocolparser.JsonType;

import org.json.simple.JSONObject;

/**

 * A type for event notification message. Its structure is similar

 * to {@link SuccessCommandResponse}.

 */

@JsonType

public interface EventNotification extends JsonObjectBased, JsonSubtype<IncomingMessage> {

  @JsonOverrideField

  @JsonSubtypeConditionCustom(condition=TypeValueCondition.class)

  MessageType getType();

  class TypeValueCondition extends EnumValueCondition<MessageType> {

    public TypeValueCondition() {

      super(EnumSet.of(MessageType.event));

    }

  }

  String getEvent();

  EventNotificationBody getBody();

  // TODO(peter.rybin): does this field really exist?

  @JsonOptionalField

  JSONObject getException();

  @JsonOptionalField

  List<SomeHandle> getRefs();

}