1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.eclipse.aether.spi.connector.transport;
20
21 import java.net.URI;
22 import java.util.Map;
23
24 /**
25 * A task to check the existence of a resource in the remote repository. <em>Note:</em> The listener returned from
26 * {@link #getListener()} is only used in the context of {@link TransportListener#transportPropertiesAvailable(Map)}.
27 *
28 * @see Transporter#peek(PeekTask)
29 */
30 public final class PeekTask extends TransportTask {
31
32 /**
33 * Creates a new task for the specified remote resource.
34 *
35 * @param location The relative location of the resource in the remote repository, must not be {@code null}.
36 */
37 public PeekTask(URI location) {
38 setLocation(location);
39 }
40
41 @Override
42 public String toString() {
43 return "?? " + getLocation();
44 }
45
46 /**
47 * Sets the listener that is to be notified during the transfer.
48 *
49 * @param listener The listener to notify of progress, may be {@code null}.
50 * @return This task for chaining, never {@code null}.
51 */
52 public PeekTask setListener(TransportListener listener) {
53 super.setListener(listener);
54 return this;
55 }
56 }