File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\console\HyperlinkNote.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2010-2011, CloudBees, Inc.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.console;
25
26 import hudson.Extension;
27 import hudson.MarkupText;
28 import jenkins.model.Jenkins;
29
30 import java.io.IOException;
31 import java.util.logging.Level;
32 import java.util.logging.Logger;
33
34 /**
35 * Turns a text into a hyperlink by specifying the URL separately.
36 *
37 * @author Kohsuke Kawaguchi
38 * @since 1.362
39 * @see ModelHyperlinkNote
40 */
41 public class HyperlinkNote extends ConsoleNote {
42 /**
43 * If this starts with '/', it's interpreted as a path within the context path.
44 */
45 private final String url;
46 private final int length;
47
48 public HyperlinkNote(String url, int length) {
49 this.url = url;
50 this.length = length;
51 }
52
53 @Override
54 public ConsoleAnnotator annotate(Object context, MarkupText text, int charPos) {
55 String url = this.url;
56 if (url.startsWith("/"))
57 url = Jenkins.getInstance().getRootUrl()+url.substring(1);
58 text.addMarkup(charPos, charPos + length, "<a href='" + url + "'"+extraAttributes()+">", "</a>");
59 return null;
60 }
61
62 protected String extraAttributes() {
63 return "";
64 }
65
66 public static String encodeTo(String url, String text) {
67 try {
68 return new HyperlinkNote(url,text.length()).encode()+text;
69 } catch (IOException e) {
70 // impossible, but don't make this a fatal problem
71 LOGGER.log(Level.WARNING, "Failed to serialize "+HyperlinkNote.class,e);
72 return text;
73 }
74 }
75
76 @Extension
77 public static class DescriptorImpl extends ConsoleAnnotationDescriptor {
78 public String getDisplayName() {
79 return "Hyperlinks";
80 }
81 }
82
83 private static final Logger LOGGER = Logger.getLogger(HyperlinkNote.class.getName());
84 }
85