1 /* 2 * ==================================================================== 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * ==================================================================== 20 * 21 * This software consists of voluntary contributions made by many 22 * individuals on behalf of the Apache Software Foundation. For more 23 * information on the Apache Software Foundation, please see 24 * <http://www.apache.org/>. 25 * 26 */ 27 28 package org.apache.hc.core5.util; 29 30 import java.util.concurrent.TimeUnit; 31 import java.util.concurrent.TimeoutException; 32 33 /** 34 * A specialization of {@link TimeoutException} that carries a deadline and an actual value, both as UNIX times. 35 * 36 * @since 5.0 37 */ 38 public class DeadlineTimeoutException extends TimeoutException { 39 40 private static final long serialVersionUID = 1L; 41 42 /** 43 * Creates a new exception for the given timeout deadline and actual timeout. 44 * 45 * @param deadline When was the deadline in UNIX time. 46 * @return a new TimeoutValueException. 47 */ 48 public static DeadlineTimeoutException from(final Deadline deadline) { 49 return new DeadlineTimeoutException(deadline); 50 } 51 52 private final Deadline deadline; 53 54 /** 55 * Creates a new exception for the given timeout deadline and actual timeout. 56 * 57 * @param deadline When was the deadline in UNIX time. 58 */ 59 private DeadlineTimeoutException(final Deadline deadline) { 60 // Deadline in a format like ISO8601: YYYY-MM-DDThh:mm:ss.sTZD 61 // We use the TimeZone zone ID because we cannot get from String.format() in 62 // Java 7 and the short names have been deprecated. 63 super(deadline.format(TimeUnit.MILLISECONDS)); 64 this.deadline = deadline; 65 } 66 67 /** 68 * The expected deadline for this timeout since the start of UNIX time. 69 * 70 * @return The expected deadline for this timeout since the start of UNIX time. 71 */ 72 public Deadline getDeadline() { 73 return deadline; 74 } 75 76 }