1 /*
   2  * Copyright (c) 2007, 2009, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.nio.file.attribute;
  27 
  28 import java.io.IOException;
  29 
  30 /**
  31  * Checked exception thrown when a lookup of {@link UserPrincipal} fails because
  32  * the principal does not exist.
  33  *
  34  * @since 1.7
  35  */
  36 
  37 public class UserPrincipalNotFoundException
  38     extends IOException
  39 {
  40     @java.io.Serial
  41     static final long serialVersionUID = -5369283889045833024L;
  42 
  43     private final String name;
  44 
  45     /**
  46      * Constructs an instance of this class.
  47      *
  48      * @param   name
  49      *          the principal name; may be {@code null}
  50      */
  51     public UserPrincipalNotFoundException(String name) {
  52         super();
  53         this.name = name;
  54     }
  55 
  56     /**
  57      * Returns the user principal name if this exception was created with the
  58      * user principal name that was not found, otherwise {@code null}.
  59      *
  60      * @return  the user principal name or {@code null}
  61      */
  62     public String getName() {
  63         return name;
  64     }
  65 }