/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You 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
    *
    *      https://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 org.apache.commons.pool2;
  
  import java.time.Duration;
  import java.util.concurrent.atomic.AtomicInteger;
  
  import org.apache.commons.lang3.ThreadUtils;
  
  /**
   * <p>Object created by {@link WaiterFactory}. Maintains active / valid state,
   * last passivated and idle times.  Waits with configurable latency when
   * {@link #doWait()} method is called.</p>
   *
   * <p>This class is *not* threadsafe.</p>
   */
  public class Waiter {
      private static final AtomicInteger instanceCount = new AtomicInteger();
  
      /**
       * Sleeps for the given duration while ignoring {@link InterruptedException}.
       * <p>
       * The sleep duration may be shorter than duration if we catch a {@link InterruptedException}.
       * </p>
       *
       * @param millis the length of time to sleep in milliseconds.
       */
      public static void sleepQuietly(final long millis) {
          ThreadUtils.sleepQuietly(Duration.ofMillis(millis));
      }
  
      private boolean active;
      private boolean valid;
      private long latency;
      private long lastPassivatedMillis;
      private long lastIdleTimeMillis;
      private long passivationCount;
      private long validationCount;
  
      private final int id = instanceCount.getAndIncrement();
  
      public Waiter(final boolean active, final boolean valid, final long latency) {
          this.active = active;
          this.valid = valid;
          this.latency = latency;
          this.lastPassivatedMillis = System.currentTimeMillis();
      }
  
      /**
       * Wait for {@link #getLatency()} milliseconds.
       */
      public void doWait() {
          sleepQuietly(latency);
      }
  
      @Override
      public boolean equals(final Object obj) {
          if (!(obj instanceof Waiter)) {
              return false;
          }
          return obj.hashCode() == id;
      }
  
      /**
       * <p>Returns the last idle time for this instance in ms.</p>
       *
       * <p>When an instance is created, and each subsequent time it is passivated,
       * the {@link #getLastPassivatedMillis() lastPassivated} property is updated with the
       * current time.  When the next activation occurs, {@code lastIdleTime} is
       * updated with the elapsed time since passivation.<p>
       *
       * @return last idle time
       */
      public long getLastIdleTimeMillis() {
          return lastIdleTimeMillis;
      }
  
      /**
       * <p>Returns the system time of this instance's last passivation.</p>
       *
       * <p>When an instance is created, this field is initialized to the system time.</p>
       *
       * @return time of last passivation
       */
     public long getLastPassivatedMillis() {
         return lastPassivatedMillis;
     }
 
     public long getLatency() {
         return latency;
     }
 
     /**
      * @return how many times this instance has been passivated
      */
     public long getPassivationCount() {
         return passivationCount;
     }
 
     /**
      * @return how many times this instance has been validated
      */
     public long getValidationCount() {
         return validationCount;
     }
 
     @Override
     public int hashCode() {
         return id;
     }
 
     /**
      * Tests whether or not the instance is active.
      *
      * @return true if the last lifecycle event for this instance was activation.
      */
     public boolean isActive() {
         return active;
     }
 
     public boolean isValid() {
         validationCount++;
         return valid;
     }
 
     /**
      * <p>Sets the active state and updates {@link #getLastIdleTimeMillis() lastIdleTime}
      * or {@link #getLastPassivatedMillis() lastPassivated} as appropriate.</p>
      *
      * <p>If the active state is changing from inactive to active, lastIdleTime
      * is updated with the current time minus lastPassivated.  If the state is
      * changing from active to inactive, lastPassivated is updated with the
      * current time.</p>
      *
      * <p>{@link WaiterFactory#activateObject(PooledObject)} and
      * {@link WaiterFactory#passivateObject(PooledObject)} invoke this method on
      * their actual parameter, passing {@code true} and {@code false},
      * respectively.</p>
      *
      * @param active new active state
      */
     public void setActive(final boolean active) {
         final boolean activeState = this.active;
         if (activeState == active) {
             return;
         }
         this.active = active;
         final long currentTimeMillis = System.currentTimeMillis();
         if (active) {  // activating
             lastIdleTimeMillis = currentTimeMillis - lastPassivatedMillis;
         } else {       // passivating
             lastPassivatedMillis = currentTimeMillis;
             passivationCount++;
         }
     }
 
     public void setLatency(final long latency) {
         this.latency = latency;
     }
 
     public void setValid(final boolean valid) {
         this.valid = valid;
     }
 
     @Override
     public String toString() {
         final StringBuilder buff = new StringBuilder();
         buff.append("ID = " + id + '\n');
         buff.append("valid = " + valid + '\n');
         buff.append("active = " + active + '\n');
         buff.append("lastPassivated = " + lastPassivatedMillis + '\n');
         buff.append("lastIdleTimeMs = " + lastIdleTimeMillis + '\n');
         buff.append("latency = " + latency + '\n');
         return buff.toString();
     }
 }