Package jmri.jmrit.vsdecoder

Class VSDFile

java.lang.Object

java.util.zip.ZipFile

jmri.jmrit.vsdecoder.VSDFile

All Implemented Interfaces:

Closeable, AutoCloseable

public class VSDFile
extends ZipFile

Open a VSD file and validate the configuration part. This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	VSDFile.ValidateStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CENATT
static final int	CENATX
static final int	CENCOM
static final int	CENCRC
static final int	CENDSK
static final int	CENEXT
static final int	CENFLG
static final int	CENHDR
static final int	CENHOW
static final int	CENLEN
static final int	CENNAM
static final int	CENOFF
static final long	CENSIG
static final int	CENSIZ
static final int	CENTIM
static final int	CENVEM
static final int	CENVER
static final int	ENDCOM
static final int	ENDHDR
static final int	ENDOFF
static final long	ENDSIG
static final int	ENDSIZ
static final int	ENDSUB
static final int	ENDTOT
static final int	EXTCRC
static final int	EXTHDR
static final int	EXTLEN
static final long	EXTSIG
static final int	EXTSIZ
static final int	LOCCRC
static final int	LOCEXT
static final int	LOCFLG
static final int	LOCHDR
static final int	LOCHOW
static final int	LOCLEN
static final int	LOCNAM
static final long	LOCSIG
static final int	LOCSIZ
static final int	LOCTIM
static final int	LOCVER
protected org.jdom2.Element	root

Fields inherited from class java.util.zip.ZipFile

OPEN_DELETE, OPEN_READ

Constructor Summary

Constructors

Constructor	Description
VSDFile(String name)

Method Summary

Modifier and Type	Method	Description
File	getFile(String name)
InputStream	getInputStream(String name)
org.jdom2.Element	getRoot()
String	getStatusMessage()
String	getURL(String name)
(package private) final boolean	isInitialized()
VSDFile.ValidateStatus	validate(org.jdom2.Element xmlroot)
protected boolean	validateFiles(org.jdom2.Element el, String name, String[] fnames)
protected boolean	validateFiles(org.jdom2.Element el, String name, String[] fnames, Boolean required)
protected boolean	validateFilesNumbers(org.jdom2.Element el, String name, String[] fnames, Boolean required)
protected boolean	validateOptionalFile(org.jdom2.Element el, String name)
protected boolean	validateOptionalFile(org.jdom2.Element el, String name, Boolean required)
protected boolean	validateRequiredElement(org.jdom2.Element el, String name)
protected boolean	validateRequiredElementRange(org.jdom2.Element el, String name, int val_from, int val_to)
protected boolean	validateRequiredNotchElement(org.jdom2.Element el, String name1, String name2)

Methods inherited from class java.util.zip.ZipFile

close, entries, getComment, getEntry, getInputStream, getName, size, stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

root

protected org.jdom2.Element root

LOCSIG

static final long LOCSIG

See Also:

• Constant Field Values

EXTSIG

static final long EXTSIG

See Also:

• Constant Field Values

CENSIG

static final long CENSIG

See Also:

• Constant Field Values

ENDSIG

static final long ENDSIG

See Also:

• Constant Field Values

LOCHDR

static final int LOCHDR

See Also:

• Constant Field Values

EXTHDR

static final int EXTHDR

See Also:

• Constant Field Values

CENHDR

static final int CENHDR

See Also:

• Constant Field Values

ENDHDR

static final int ENDHDR

See Also:

• Constant Field Values

LOCVER

static final int LOCVER

See Also:

• Constant Field Values

LOCFLG

static final int LOCFLG

See Also:

• Constant Field Values

LOCHOW

static final int LOCHOW

See Also:

• Constant Field Values

LOCTIM

static final int LOCTIM

See Also:

• Constant Field Values

LOCCRC

static final int LOCCRC

See Also:

• Constant Field Values

LOCSIZ

static final int LOCSIZ

See Also:

• Constant Field Values

LOCLEN

static final int LOCLEN

See Also:

• Constant Field Values

LOCNAM

static final int LOCNAM

See Also:

• Constant Field Values

LOCEXT

static final int LOCEXT

See Also:

• Constant Field Values

EXTCRC

static final int EXTCRC

See Also:

• Constant Field Values

EXTSIZ

static final int EXTSIZ

See Also:

• Constant Field Values

EXTLEN

static final int EXTLEN

See Also:

• Constant Field Values

CENVEM

static final int CENVEM

See Also:

• Constant Field Values

CENVER

static final int CENVER

See Also:

• Constant Field Values

CENFLG

static final int CENFLG

See Also:

• Constant Field Values

CENHOW

static final int CENHOW

See Also:

• Constant Field Values

CENTIM

static final int CENTIM

See Also:

• Constant Field Values

CENCRC

static final int CENCRC

See Also:

• Constant Field Values

CENSIZ

static final int CENSIZ

See Also:

• Constant Field Values

CENLEN

static final int CENLEN

See Also:

• Constant Field Values

CENNAM

static final int CENNAM

See Also:

• Constant Field Values

CENEXT

static final int CENEXT

See Also:

• Constant Field Values

CENCOM

static final int CENCOM

See Also:

• Constant Field Values

CENDSK

static final int CENDSK

See Also:

• Constant Field Values

CENATT

static final int CENATT

See Also:

• Constant Field Values

CENATX

static final int CENATX

See Also:

• Constant Field Values

CENOFF

static final int CENOFF

See Also:

• Constant Field Values

ENDSUB

static final int ENDSUB

See Also:

• Constant Field Values

ENDTOT

static final int ENDTOT

See Also:

• Constant Field Values

ENDSIZ

static final int ENDSIZ

See Also:

• Constant Field Values

ENDOFF

static final int ENDOFF

See Also:

• Constant Field Values

ENDCOM

static final int ENDCOM

See Also:

• Constant Field Values

Constructor Details

VSDFile

public VSDFile(String name)
        throws ZipException,
IOException

Throws:

ZipException

IOException

Method Details

getStatusMessage

public String getStatusMessage()

isInitialized

final boolean isInitialized()

getRoot

public org.jdom2.Element getRoot()

getInputStream

public InputStream getInputStream(String name)

getFile

public File getFile(String name)

getURL

public String getURL(String name)

validate

public VSDFile.ValidateStatus validate(org.jdom2.Element xmlroot)

validateRequiredElement

protected boolean validateRequiredElement(org.jdom2.Element el,
 String name)

validateRequiredElementRange

protected boolean validateRequiredElementRange(org.jdom2.Element el,
 String name,
 int val_from,
 int val_to)

validateRequiredNotchElement

protected boolean validateRequiredNotchElement(org.jdom2.Element el,
 String name1,
 String name2)

validateOptionalFile

protected boolean validateOptionalFile(org.jdom2.Element el,
 String name)

validateOptionalFile

protected boolean validateOptionalFile(org.jdom2.Element el,
 String name,
 Boolean required)

validateFiles

protected boolean validateFiles(org.jdom2.Element el,
 String name,
 String[] fnames)

validateFiles

protected boolean validateFiles(org.jdom2.Element el,
 String name,
 String[] fnames,
 Boolean required)

validateFilesNumbers

protected boolean validateFilesNumbers(org.jdom2.Element el,
 String name,
 String[] fnames,
 Boolean required)