swim.api.lane.MapLane Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swim-api Show documentation
Agent programming interface
There is a newer version: 4.3.15
// Copyright 2015-2021 Swim Inc.
//
// 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
//
//     http://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 swim.api.lane;

import java.util.Map;
import swim.api.warp.WarpLane;
import swim.api.warp.function.DidCommand;
import swim.api.warp.function.DidEnter;
import swim.api.warp.function.DidLeave;
import swim.api.warp.function.DidUplink;
import swim.api.warp.function.WillCommand;
import swim.api.warp.function.WillEnter;
import swim.api.warp.function.WillLeave;
import swim.api.warp.function.WillUplink;
import swim.observable.ObservableOrderedMap;
import swim.observable.function.DidClear;
import swim.observable.function.DidDrop;
import swim.observable.function.DidRemoveKey;
import swim.observable.function.DidTake;
import swim.observable.function.DidUpdateKey;
import swim.observable.function.WillClear;
import swim.observable.function.WillDrop;
import swim.observable.function.WillRemoveKey;
import swim.observable.function.WillTake;
import swim.observable.function.WillUpdateKey;
import swim.streamlet.MapInlet;
import swim.streamlet.MapOutlet;
import swim.structure.Form;
import swim.util.Cursor;
import swim.util.OrderedMap;

public interface MapLane extends WarpLane, ObservableOrderedMap, MapInlet>, MapOutlet> {

  Form keyForm();

   MapLane keyForm(Form keyForm);

   MapLane keyClass(Class keyClass);

  Form valueForm();

   MapLane valueForm(Form valueForm);

   MapLane valueClass(Class valueClass);

  boolean isResident();

  MapLane isResident(boolean isResident);

  boolean isTransient();

  MapLane isTransient(boolean isTransient);

  @Override
  MapLane observe(Object observer);

  @Override
  MapLane unobserve(Object observer);

  @Override
  MapLane willUpdate(WillUpdateKey willUpdate);

  @Override
  MapLane didUpdate(DidUpdateKey didUpdate);

  @Override
  MapLane willRemove(WillRemoveKey willRemove);

  @Override
  MapLane didRemove(DidRemoveKey didRemove);

  @Override
  MapLane willDrop(WillDrop willDrop);

  @Override
  MapLane didDrop(DidDrop didDrop);

  @Override
  MapLane willTake(WillTake willTake);

  @Override
  MapLane didTake(DidTake didTake);

  @Override
  MapLane willClear(WillClear willClear);

  @Override
  MapLane didClear(DidClear didClear);

  @Override
  MapLane willCommand(WillCommand willCommand);

  @Override
  MapLane didCommand(DidCommand didCommand);

  @Override
  MapLane willUplink(WillUplink willUplink);

  @Override
  MapLane didUplink(DidUplink didUplink);

  @Override
  MapLane willEnter(WillEnter willEnter);

  @Override
  MapLane didEnter(DidEnter didEnter);

  @Override
  MapLane willLeave(WillLeave willLeave);

  @Override
  MapLane didLeave(DidLeave didLeave);

  OrderedMap snapshot();

  @Override
  Cursor keyIterator();

}